Class RecordBatchWriter<T>

Type parameters

T: {} = any

Hierarchy

ReadableInterop<Uint8Array>
- RecordBatchWriter

Implements

Writable<RecordBatch<T>>

Index

Constructors

constructor

Accessors

closed

Methods

Constructors

constructor

new RecordBatchWriter<T>(options?: RecordBatchStreamWriterOptions): RecordBatchWriter<T>

Overrides ReadableInterop<Uint8Array>.constructor
- Defined in ipc/writer.ts:69
Type parameters
- T: {} = any
Parameters
- Optional options: RecordBatchStreamWriterOptions
Returns RecordBatchWriter<T>

Accessors

closed

get closed(): Promise<void>

- Defined in ipc/writer.ts:111
Returns Promise<void>

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncByteQueue<Uint8Array>

- Defined in ipc/writer.ts:112
Returns AsyncByteQueue<Uint8Array>

abort

abort(reason?: any): void

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

close

close(): void

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

finish

finish(): RecordBatchWriter<T>

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

pipe

pipe<R>(writable: R, options?: { end?: boolean }): R

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

pipeThrough

pipeThrough<R>(duplex: { readable: R; writable: WritableStream<Uint8Array> }, options?: PipeOptions): ReadableStream<any>

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

pipeTo

pipeTo(writable: WritableStream<Uint8Array>, options?: PipeOptions): Promise<void>

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

reset

reset(sink?: WritableSink<ArrayBufferViewInput>, schema?: null | Schema<T>): RecordBatchWriter<T>

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

tee

tee(): [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]

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

toDOMStream

toDOMStream(options?: ReadableDOMStreamOptions): ReadableStream<Uint8Array>

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

toNodeStream

toNodeStream(options?: ReadableOptions): Readable

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

toString

toString(sync: true): string
toString(sync?: false): Promise<string>

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

toUint8Array

toUint8Array(sync: true): Uint8Array
toUint8Array(sync?: false): Promise<Uint8Array>

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

write

write(payload?: null | Table<T> | RecordBatch<T> | Iterable<RecordBatch<T>>): void

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

writeAll

writeAll(input: Table<T> | Iterable<RecordBatch<T>>): RecordBatchWriter<T>
writeAll(input: AsyncIterable<RecordBatch<T>>): Promise<RecordBatchWriter<T>>
writeAll(input: PromiseLike<AsyncIterable<RecordBatch<T>>>): Promise<RecordBatchWriter<T>>
writeAll(input: PromiseLike<Table<T> | Iterable<RecordBatch<T>>>): Promise<RecordBatchWriter<T>>

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

Static throughDOM

throughDOM<T>(writableStrategy?: QueuingStrategy<RecordBatch<T>> & { autoDestroy: boolean }, readableStrategy?: { highWaterMark?: number; size?: any }): { readable: ReadableStream<Uint8Array>; writable: WritableStream<RecordBatch<T> | Table<T>> }

- Defined in ipc/writer.ts:60
nocollapse

Type parameters
- T: {}
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>>

Static throughNode

throughNode(options?: DuplexOptions & { autoDestroy: boolean }): Duplex

- Defined in ipc/writer.ts:56
nocollapse

Parameters
- Optional options: DuplexOptions & { autoDestroy: boolean }
Returns Duplex

Generated using TypeDoc