interface EndpointOptions {
    id?: string;
    isEssential?: boolean;
    number?: number;
    owner?: Agent | Endpoint<Empty>;
    parts?: Iterable<Definition<Empty>, any, any>;
}

Hierarchy (view full)

Properties

id?: string

The endpoint's string identifier. Must be unique within the parent.

If you omit the identifier the node assigns a generated one for you.

isEssential?: boolean

Designates whether an endpoint is essential.

Endpoints are essential by default but you may disable by setting this to false.

number?: number

The endpoint number. Must be unique within the node.

If you omit the endpoint number the node assigns a sequential one for you.

owner?: Agent | Endpoint<Empty>

The owner of the endpoint.

If provided, takes ownership of the endpoint at construction.

parts?: Iterable<Definition<Empty>, any, any>

Child endpoints.

This is the inverse of setting owner above. The endpoint instantiates and takes ownership of child endpoints at construction time.