Interface SubscriptionStore

Implements subscription store

Hierarchy

Properties

commitServicePosition commitSubscriptionPosition createService createSubscription deleteService deleteSubscription dispose listen loadServices loadSubscriptions loadSubscriptionsByProducer name searchSubscriptions seed toggleSubscription updateService updateSubscription

Properties

commitServicePosition

commitServicePosition: ((id, position) => Promise<void>)

Type declaration

    • (id, position): Promise<void>

    • Commits a new channel position

      Parameters

      • id: string

        service id

      • position: number

        new position

      Returns Promise<void>

commitSubscriptionPosition

commitSubscriptionPosition: ((id, position) => Promise<void>)

Type declaration

    • (id, position): Promise<void>

    • Commits a new subscription position

      Parameters

      • id: string

        subscription id

      • position: number

        new position

      Returns Promise<void>

createService

createService: ((service) => Promise<void>)

Type declaration

    • (service): Promise<void>

    • Creates a new service

      Parameters

      Returns Promise<void>

createSubscription

createSubscription: ((sub) => Promise<void>)

Type declaration

    • (sub): Promise<void>

    • Creates a new subscription

      Parameters

      Returns Promise<void>

deleteService

deleteService: ((id) => Promise<void>)

Type declaration

    • (id): Promise<void>

    • Deletes a service

      Parameters

      • id: string

        the service id

      Returns Promise<void>

deleteSubscription

deleteSubscription: ((id) => Promise<void>)

Type declaration

    • (id): Promise<void>

    • Deletes a subscription

      Parameters

      • id: string

        the subscription id

      Returns Promise<void>

dispose

dispose: Disposer

listen

listen: ((servicesCallback, subscriptionsCallback) => void)

Type declaration

    • (servicesCallback, subscriptionsCallback): void

    • Starts listening for changes in services and subscriptions

      Parameters

      Returns void

loadServices

loadServices: ((id?) => Promise<Service[]>)

Type declaration

    • (id?): Promise<Service[]>

    • Loads services from store

      Parameters

      • Optional id: string

        optional service id

      Returns Promise<Service[]>

loadSubscriptions

loadSubscriptions: ((id?) => Promise<Subscription[]>)

Type declaration

    • (id?): Promise<Subscription[]>

    • Loads subscriptions from store

      Parameters

      • Optional id: string

        optional subscription id

      Returns Promise<Subscription[]>

loadSubscriptionsByProducer

loadSubscriptionsByProducer: ((producer) => Promise<Subscription[]>)

Type declaration

    • (producer): Promise<Subscription[]>

    • Loads subscriptions by producer

      Parameters

      • producer: string

        the producer name

      Returns Promise<Subscription[]>

Readonly name

name: string

searchSubscriptions

searchSubscriptions: ((pattern) => Promise<Subscription[]>)

Type declaration

    • (pattern): Promise<Subscription[]>

    • Searches subscriptions from store

      Parameters

      • pattern: string

        search pattern

      Returns Promise<Subscription[]>

seed

seed: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Store initializer

      Returns Promise<void>

      a stream listener factory for this store

toggleSubscription

toggleSubscription: ((id) => Promise<void>)

Type declaration

    • (id): Promise<void>

    • Toggles a subscription (activation)

      Parameters

      • id: string

        the subscription id

      Returns Promise<void>

updateService

updateService: ((service) => Promise<void>)

Type declaration

    • (service): Promise<void>

    • Updates a service

      Parameters

      Returns Promise<void>

updateSubscription

updateSubscription: ((sub) => Promise<void>)

Type declaration

    • (sub): Promise<void>

    • Updates a subscription

      Parameters

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc