moqtail-ts
    Preparing search index...

    Type Alias SubscribeOptions

    Parameters for subscribing to a track's live objects.

    await client.subscribe({
      fullTrackName,
      priority: 0,
      groupOrder: GroupOrder.Original,
      forward: true,
      filterType: FilterType.LatestObject
    })

    await client.subscribe({
      fullTrackName,
      priority: 32,
      groupOrder: GroupOrder.Original,
      forward: true,
      filterType: FilterType.AbsoluteRange,
      startLocation: { group: 100n, subgroup: 0n, object: 0n },
      endGroup: 120n
    })
    type SubscribeOptions = {
        endGroup?: bigint | number;
        filterType: FilterType;
        forward: boolean;
        fullTrackName: FullTrackName;
        groupOrder: GroupOrder;
        parameters?: VersionSpecificParameters;
        priority: number;
        startLocation?: Location;
        trackAlias?: bigint | number;
    }
    Index

    Properties

    endGroup? filterType forward fullTrackName groupOrder parameters? priority startLocation? trackAlias?

    Properties

    endGroup?: bigint | number

    Required for FilterType.AbsoluteRange; exclusive upper group boundary (coerced to bigint if number provided).

    filterType: FilterType

    FilterType variant controlling starting subset (e.g. FilterType.LatestObject).

    forward: boolean

    If true, deliver objects forward (ascending); if false, reverse/backward semantics (implementation dependent).

    fullTrackName: FullTrackName

    Fully qualified track identifier (FullTrackName).

    groupOrder: GroupOrder

    Desired GroupOrder (e.g. GroupOrder.Original) specifying delivery ordering semantics.

    parameters?: VersionSpecificParameters

    Optional extension VersionSpecificParameters appended to the SUBSCRIBE control message.

    priority: number

    Subscriber priority (0 = highest, 255 = lowest). Values outside range are clamped. Fractional values are rounded.

    startLocation?: Location

    Required for FilterType.AbsoluteStart / FilterType.AbsoluteRange; earliest Location to include.

    trackAlias?: bigint | number

    Caller supplied alias for the track (else auto-generated); may be number or bigint.

    Settings

    Member Visibility

    On This Page

    Properties