ChainGraph API Documentation / @badaitech/chaingraph-types / EventQueue
Class: EventQueue<T>
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:18
Type Parameters
T
T
Constructors
Constructor
new EventQueue<
T>(maxBufferSize):EventQueue<T>
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:28
Parameters
maxBufferSize
number = 1000
Returns
EventQueue<T>
Methods
close()
close():
Promise<void>
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:154
Returns
Promise<void>
createIterator()
createIterator(
signal?):AsyncIterableIterator<T>
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:222
Parameters
signal?
AbortSignal
Returns
AsyncIterableIterator<T>
getStats()
getStats():
object
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:208
Returns
object
bufferSize
bufferSize:
number
currentPosition
currentPosition:
number
isClosed
isClosed:
boolean
subscriberCount
subscriberCount:
number
subscribers
subscribers:
object[]
onClose()
onClose(
handler): () =>void
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:231
Register a handler to be called when the queue is closed
Parameters
handler
() => void | Promise<void>
Function to be called on queue close
Returns
Function to unregister the handler
():
void
Returns
void
publish()
publish(
event):Promise<void>
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:66
Parameters
event
T
Returns
Promise<void>
subscribe()
subscribe(
handler,onError?,onComplete?): () =>void
Defined in: packages/chaingraph-types/src/utils/event-queue.ts:32
Parameters
handler
(event) => void | Promise<void>
onError?
(error) => void
onComplete?
() => void | Promise<void>
Returns
():
void
Returns
void