ArrowSubscription

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:924)

Implements

• AsyncIterator<Table, undefined, SubscriptionReadOptions | undefined>
• AsyncIterable<Table>

Constructors

Constructor

new ArrowSubscription(inner): ArrowSubscription

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:926)

Parameters

inner

NativeSubscription

Returns

ArrowSubscription

Methods

[asyncIterator]()

[asyncIterator](): this

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:931)

Returns

this

Implementation of

AsyncIterable.[asyncIterator]

---

next()

next(options?): Promise<IteratorResult<Table, undefined>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:928)

Return the next zero-copy Arrow table; one native crossing may contain many rows.

Parameters

options?

SubscriptionReadOptions

Returns

Promise<IteratorResult<Table, undefined>>

Implementation of

AsyncIterator.next

---

return()

return(): Promise<IteratorResult<Table, undefined>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:930)

Returns

Promise<IteratorResult<Table, undefined>>

Implementation of

AsyncIterator.return

---

unsubscribe()

unsubscribe(drain?): Promise<Table[]>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:929)

Parameters

drain?

boolean

Returns

Promise<Table[]>