Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SyncpsPubsub

Index

Type aliases

FilterPubsCallback

FilterPubsCallback: (items: FilterPubItem[]) => FilterPubItem[]

Type declaration

    • Callback to decide what publications to be included in a response. Argument contains unexpired publications only. It should return a priority list of publications to be included in the response.

      Parameters

      Returns FilterPubItem[]

IsExpiredCallback

IsExpiredCallback: (pub: Data) => boolean | number

Type declaration

    • (pub: Data): boolean | number
    • Callback to determine if a publication is expired.

      The callback can return either:

      • boolean to indicate whether the publication is expired.
      • number, interpreted as Unix timestamp (milliseconds) of publication creation time. The publication is considered expired if this timestamp is before NOW - (maxPubLifetime+maxClockSkew) or after NOW + maxClockSkew.

      Parameters

      • pub: Data

      Returns boolean | number

ModifyPublicationCallback

ModifyPublicationCallback: (pub: Data) => void

Type declaration

    • (pub: Data): void
    • Parameters

      • pub: Data

      Returns void

PublishCallback

PublishCallback: (pub: Data, confirmed: boolean) => void

Type declaration

    • (pub: Data, confirmed: boolean): void
    • Parameters

      • pub: Data
      • confirmed: boolean

      Returns void

Generated using TypeDoc