Class AsyncSubscriber<Message>

Subscribe to an MessageSubscription as AsyncIterator. This is useful for GraphQL subscriptions.

Type Parameters

Message

Implements

AsyncIterableIterator<Message>
Closeable
AsyncDisposable

Index

Constructors

Properties

abort bufferSize fcfs pullQueue pushQueue running unsubscribe

Methods

[asyncDispose] [asyncIterator] close next pull push return throw

Constructors

constructor

new AsyncSubscriber<Message>(subscription, options?): AsyncSubscriber<Message>
Type Parameters
- Message
Parameters
- subscription: MessageSubscription<Message, object>
  Subscription to listen to.
- Optional options: AsyncSubscriberOptions
  Optional options.
Returns AsyncSubscriber<Message>
- Defined in cqrs/src/iterator.ts:18

Properties

`Private` `Readonly` abort

abort: undefined | AbortSignal

`Private` `Readonly` bufferSize

bufferSize: number

`Private` `Readonly` fcfs

fcfs: boolean

`Private` `Readonly` pullQueue

pullQueue: ArrayDeque<((value) => void)> = ...

Type declaration

- (value): void
- Parameters
  - value: IteratorResult<Message, any>
  Returns void

`Private` `Readonly` pushQueue

pushQueue: ArrayDeque<Message> = ...

`Private` running

running: boolean = true

`Private` unsubscribe

unsubscribe: MaybePromise<Unsubscribe>

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
- Defined in cqrs/src/iterator.ts:69

[asyncIterator]

[asyncIterator](): AsyncSubscriber<Message>
Returns AsyncSubscriber<Message>
Implementation of AsyncIterableIterator.[asyncIterator]
- Defined in cqrs/src/iterator.ts:31

close

close(): Promise<void>
Closes this object and releases any system resource associated with it.

Returns Promise<void>
Implementation of Closeable.close
- Defined in cqrs/src/iterator.ts:56

next

next(): Promise<IteratorResult<Message, any>>
Returns Promise<IteratorResult<Message, any>>
Implementation of AsyncIterableIterator.next
- Defined in cqrs/src/iterator.ts:35

`Private` pull

pull(): Promise<IteratorResult<Message, any>>
Returns Promise<IteratorResult<Message, any>>
- Defined in cqrs/src/iterator.ts:85

`Private` push

push(value): void
Parameters
- value: Message
Returns void
- Defined in cqrs/src/iterator.ts:73

return

return(): Promise<IteratorResult<Message, any>>
Returns Promise<IteratorResult<Message, any>>
Implementation of AsyncIterableIterator.return
- Defined in cqrs/src/iterator.ts:46

throw

throw(error): Promise<IteratorResult<Message, any>>
Parameters
- error: unknown
Returns Promise<IteratorResult<Message, any>>
Implementation of AsyncIterableIterator.throw
- Defined in cqrs/src/iterator.ts:51

Generated using TypeDoc