DeliveryStream
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:915)
Type Parameters
TData
TData = Table
Implements
AsyncIterator<SubscriptionDelivery<TData>,undefined,SubscriptionReadOptions|undefined>AsyncIterable<SubscriptionDelivery<TData>>
Constructors
Constructor
new DeliveryStream<
TData>(inner,project):DeliveryStream<TData>
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:918)
A function projects zero-copy descriptors; { ipcFile } projects one Arrow IPC file.
Parameters
inner
NativeSubscription
project
((delivery) => SubscriptionDelivery<TData>) | IpcFileDeliveryProjection<TData>
Returns
DeliveryStream<TData>
Methods
[asyncIterator]()
[asyncIterator]():
this
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:922)
Returns
this
Implementation of
AsyncIterable.[asyncIterator]
next()
next(
options?):Promise<IteratorResult<SubscriptionDelivery<TData>,undefined>>
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:919)
Parameters
options?
Returns
Promise<IteratorResult<SubscriptionDelivery<TData>, undefined>>
Implementation of
AsyncIterator.next
return()
return():
Promise<IteratorResult<SubscriptionDelivery<TData>,undefined>>
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:921)
Returns
Promise<IteratorResult<SubscriptionDelivery<TData>, undefined>>
Implementation of
AsyncIterator.return
unsubscribe()
unsubscribe(
drain?):Promise<SubscriptionDelivery<TData>[]>
Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:920)
Parameters
drain?
boolean
Returns
Promise<SubscriptionDelivery<TData>[]>