Class RecordBatchWriter<T>

Type Parameters

T extends TypeMap = any

Hierarchy

ReadableInterop<Uint8Array>
- RecordBatchWriter

Implements

Writable<RecordBatch<T>>

Index

Constructors

constructor

new RecordBatchWriter<T>(options?: RecordBatchStreamWriterOptions): RecordBatchWriter<T>
Type Parameters
- T extends TypeMap = any
Parameters
- Optional options: RecordBatchStreamWriterOptions
Returns RecordBatchWriter<T>
Overrides ReadableInterop<Uint8Array>.constructor
- Defined in ipc/writer.ts:69

Accessors

closed

get closed(): Promise<void>
Returns Promise<void>
Implementation of Writable.closed
- Defined in ipc/writer.ts:111

Methods

[asyncIterator]

[asyncIterator](): AsyncByteQueue<Uint8Array>
Returns AsyncByteQueue<Uint8Array>
- Defined in ipc/writer.ts:112

abort

abort(reason?: any): void
Parameters
- Optional reason: any
Returns void
Implementation of Writable.abort
- Defined in ipc/writer.ts:119

close

close(): void
Returns void
Implementation of Writable.close
- Defined in ipc/writer.ts:116

finish

finish(): RecordBatchWriter<T>
Returns RecordBatchWriter<T>
- Defined in ipc/writer.ts:122

pipe

pipe<R>(writable: R, options?: { end?: boolean }): R
Type Parameters
- R extends WritableStream<R>
Parameters
- writable: R
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns R
Inherited from ReadableInterop.pipe
- Defined in io/interfaces.ts:75

pipeThrough

pipeThrough<R>(duplex: { readable: R; writable: WritableStream<Uint8Array> }, options?: StreamPipeOptions): ReadableStream<any>
Type Parameters
- R extends ReadableStream<any, R>
Parameters
- duplex: { readable: R; writable: WritableStream<Uint8Array> }
  - readable: R
  - writable: WritableStream<Uint8Array>
- Optional options: StreamPipeOptions
Returns ReadableStream<any>
Inherited from ReadableInterop.pipeThrough
- Defined in io/interfaces.ts:79

pipeTo

pipeTo(writable: WritableStream<Uint8Array>, options?: StreamPipeOptions): Promise<void>
Parameters
- writable: WritableStream<Uint8Array>
- Optional options: StreamPipeOptions
Returns Promise<void>
Inherited from ReadableInterop.pipeTo
- Defined in io/interfaces.ts:78

reset

reset(sink?: WritableSink<ArrayBufferViewInput>, schema?: null | Schema<T>): RecordBatchWriter<T>
Parameters
- sink: WritableSink<ArrayBufferViewInput> = ...
- schema: null | Schema<T> = null
Returns RecordBatchWriter<T>
- Defined in ipc/writer.ts:126

tee

tee(): [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]
Returns [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]
Inherited from ReadableInterop.tee
- Defined in io/interfaces.ts:72

toDOMStream

toDOMStream(options?: ReadableDOMStreamOptions): ReadableStream<Uint8Array>
Parameters
- Optional options: ReadableDOMStreamOptions
Returns ReadableStream<Uint8Array>
Overrides ReadableInterop.toDOMStream
- Defined in ipc/writer.ts:113

toNodeStream

toNodeStream(options?: ReadableOptions): Readable
Parameters
- Optional options: ReadableOptions
Returns Readable
Overrides ReadableInterop.toNodeStream
- Defined in ipc/writer.ts:114

toString

toString(sync: true): string
Parameters
- sync: true
Returns string
- Defined in ipc/writer.ts:87
toString(sync?: false): Promise<string>
Parameters
- Optional sync: false
Returns Promise<string>
- Defined in ipc/writer.ts:88

toUint8Array

toUint8Array(sync: true): Uint8Array
Parameters
- sync: true
Returns Uint8Array
- Defined in ipc/writer.ts:92
toUint8Array(sync?: false): Promise<Uint8Array>
Parameters
- Optional sync: false
Returns Promise<Uint8Array>
- Defined in ipc/writer.ts:93

write

write(payload?: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>): void
Parameters
- Optional payload: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>
Returns void
Implementation of Writable.write
- Defined in ipc/writer.ts:161

writeAll

writeAll(input: Table<T> | Iterable<RecordBatch<T>>): RecordBatchWriter<T>
Parameters
- input: Table<T> | Iterable<RecordBatch<T>>
Returns RecordBatchWriter<T>
- Defined in ipc/writer.ts:98
writeAll(input: AsyncIterable<RecordBatch<T>>): Promise<RecordBatchWriter<T>>
Parameters
- input: AsyncIterable<RecordBatch<T>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:99
writeAll(input: PromiseLike<AsyncIterable<RecordBatch<T>>>): Promise<RecordBatchWriter<T>>
Parameters
- input: PromiseLike<AsyncIterable<RecordBatch<T>>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:100
writeAll(input: PromiseLike<Table<T> | Iterable<RecordBatch<T>>>): Promise<RecordBatchWriter<T>>
Parameters
- input: PromiseLike<Table<T> | Iterable<RecordBatch<T>>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:101

`Static` throughDOM

throughDOM<T>(writableStrategy?: QueuingStrategy<RecordBatch<T>> & { autoDestroy: boolean }, readableStrategy?: { highWaterMark?: number; size?: any }): { readable: ReadableStream<Uint8Array>; writable: WritableStream<RecordBatch<T> | Table<T>> }
Nocollapse
Type Parameters
- T extends TypeMap
Parameters
- Optional writableStrategy: QueuingStrategy<RecordBatch<T>> & { autoDestroy: boolean }
- Optional readableStrategy: { highWaterMark?: number; size?: any }
  - Optional highWaterMark?: number
  - Optional size?: any
Returns { readable: ReadableStream<Uint8Array>; writable: WritableStream<RecordBatch<T> | Table<T>> }
- readable: ReadableStream<Uint8Array>
- writable: WritableStream<RecordBatch<T> | Table<T>>
- Defined in ipc/writer.ts:60

`Static` throughNode

throughNode(options?: DuplexOptions & { autoDestroy: boolean }): Duplex
Nocollapse
Parameters
- Optional options: DuplexOptions & { autoDestroy: boolean }
Returns Duplex
- Defined in ipc/writer.ts:56

Class RecordBatchWriter<T>

Type Parameters

T extends TypeMap = any

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

T extends TypeMap = any

Parameters

Optional options: RecordBatchStreamWriterOptions

Returns RecordBatchWriter<T>

Accessors

closed

Returns Promise<void>

Methods

[asyncIterator]

Returns AsyncByteQueue<Uint8Array>

abort

Parameters

Optional reason: any

Returns void

close

Returns void

finish

Returns RecordBatchWriter<T>

pipe

Type Parameters

R extends WritableStream<R>

Parameters

writable: R

Optional options: { end?: boolean }

Optional end?: boolean

Returns R

pipeThrough

Type Parameters

R extends ReadableStream<any, R>

Parameters

duplex: { readable: R; writable: WritableStream<Uint8Array> }

readable: R

writable: WritableStream<Uint8Array>

Optional options: StreamPipeOptions

Returns ReadableStream<any>

pipeTo

Parameters

writable: WritableStream<Uint8Array>

Optional options: StreamPipeOptions

Returns Promise<void>

reset

Parameters

sink: WritableSink<ArrayBufferViewInput> = ...

schema: null | Schema<T> = null

Returns RecordBatchWriter<T>

tee

Returns [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]

toDOMStream

Parameters

Optional options: ReadableDOMStreamOptions

Returns ReadableStream<Uint8Array>

toNodeStream

Parameters

Optional options: ReadableOptions

Returns Readable

toString

Parameters

sync: true

Returns string

Parameters

Optional sync: false

Returns Promise<string>

toUint8Array

Parameters

sync: true

Returns Uint8Array

Parameters

Optional sync: false

`Optional` options: RecordBatchStreamWriterOptions

`Optional` reason: any

`Optional` options: { end?: boolean }

`Optional` end?: boolean

`Optional` options: StreamPipeOptions

`Optional` options: StreamPipeOptions

`Optional` options: ReadableDOMStreamOptions

`Optional` options: ReadableOptions

`Optional` sync: false

`Optional` sync: false

`Optional` payload: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>

`Static` throughDOM

`Optional` writableStrategy: QueuingStrategy<RecordBatch<T>> & { autoDestroy: boolean }

`Optional` readableStrategy: { highWaterMark?: number; size?: any }

`Optional` highWaterMark?: number

`Optional` size?: any

`Static` throughNode

`Optional` options: DuplexOptions & { autoDestroy: boolean }