Interface SubscriptionStore

Stores subscriptions

Poll: When no active lease found, creates new consumer lease if events are found after watermark
Ack: Updates watermark if received before lease expiration

Hierarchy

Disposable
- SubscriptionStore

Index

Properties

ack dispose drop name poll seed subscriptions

Properties

ack

ack: (<E>(lease, watermark) => Promise<boolean>)

Type declaration

- <E>(lease, watermark): Promise<boolean>
- Acknowledges consumer handling events on active lease
  Type Parameters
  - E extends Messages
  Parameters
  - lease: Lease<E>
    
    active lease
  - watermark: number
    
    new watermark poiting to the last consumed event
  Returns Promise<boolean>
  false when lease expired

dispose

dispose: Disposer

drop

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

Type declaration

- (): Promise<void>
- Drops the store
  
  Returns Promise<void>

`Readonly` name

name: string

poll

poll: (<E>(consumer, options) => Promise<undefined | Lease<E>>)

Type declaration

- <E>(consumer, options): Promise<undefined | Lease<E>>
- Polls the store for events created after a watermark
  Type Parameters
  - E extends Messages
  Parameters
  - consumer: string
    
    consumer name
  - options: PollOptions
    
    poll options
  Returns Promise<undefined | Lease<E>>
  a new lease when events are found

seed

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

Type declaration

- (): Promise<void>
- Seeds the store
  
  Returns Promise<void>

subscriptions

subscriptions: (() => Promise<Subscription[]>)

Type declaration

- (): Promise<Subscription[]>
- Gets stored subscriptions
  
  Returns Promise<Subscription[]>

Generated using TypeDoc