Interface CommandBuilderContext

Context object for command generation.

interface CommandBuilderContext {
    context: Readonly<CommandBuilderContext>;
    when: ((start, end?) => CommandIntervalBuilder);
    toFilter(mediaType): Filter;
    toString(): string;
}

Index

Properties

Methods

toFilter toString

Properties

context

context: Readonly<CommandBuilderContext>

Access to the context when using destructuring function parameter.

when

when: ((start, end?) => CommandIntervalBuilder)

Create a interval and return its builder.

Type declaration

- (start, end?): CommandIntervalBuilder
- Parameters
  - start: string | number
    The start time of the interval.
  - Optional end: string | number
    The end time of the interval.
  Returns CommandIntervalBuilder

Returns

The interval builder.

Methods

toFilter

toFilter(mediaType): Filter
Create the corresponding sendcmd filter.
Parameters
- mediaType: PipeMediaType
  Media type of the sibling pads.
Returns Filter
- Defined in index.ts:830

toString

toString(): string
Return the string representation of this commands description.

Returns string
- Defined in index.ts:835