Class RecordBatchWriter<T>

Type Parameters

T extends TypeMap = any

Hierarchy

ReadableInterop<Uint8Array>
- RecordBatchWriter

Index

Constructors

constructor

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

Accessors

closed

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

Methods

[asyncIterator]

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

abort

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

close

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

finish

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

pipe

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

pipeThrough

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

pipeTo

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

reset

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

tee

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

toDOMStream

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

toNodeStream

toNodeStream(options?: ReadableOptions<Readable>): Readable
Parameters
- Optionaloptions: ReadableOptions<Readable>
Returns Readable
Overrides ReadableInterop.toNodeStream
- Defined in ipc/writer.ts:140

toString

toString(sync: true): string
Returns a string representation of an object.
Parameters
- sync: true
Returns string
- Defined in ipc/writer.ts:113
toString(sync?: false): Promise<string>
Parameters
- Optionalsync: false
Returns Promise<string>
- Defined in ipc/writer.ts:114

toUint8Array

toUint8Array(sync: true): Uint8Array
Parameters
- sync: true
Returns Uint8Array
- Defined in ipc/writer.ts:118
toUint8Array(sync?: false): Promise<Uint8Array>
Parameters
- Optionalsync: false
Returns Promise<Uint8Array>
- Defined in ipc/writer.ts:119

write

write(
payload?: RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>> | null,
): void
Parameters
- Optionalpayload: RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>> | null
Returns void
Implementation of Writable.write
- Defined in ipc/writer.ts:188
write(chunk: RecordBatch<T>, controller: WritableStreamDefaultController): void
Parameters
- chunk: RecordBatch<T>
- controller: WritableStreamDefaultController
Returns void
Implementation of Writable.write
- Defined in ipc/writer.ts:190

writeAll

writeAll(input: Table<T> | Iterable<RecordBatch<T>>): this
Parameters
- input: Table<T> | Iterable<RecordBatch<T>>
Returns this
- Defined in ipc/writer.ts:124
writeAll(input: AsyncIterable<RecordBatch<T>>): Promise<RecordBatchWriter<T>>
Parameters
- input: AsyncIterable<RecordBatch<T>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:125
writeAll(
input: PromiseLike<AsyncIterable<RecordBatch<T>>>,
): Promise<RecordBatchWriter<T>>
Parameters
- input: PromiseLike<AsyncIterable<RecordBatch<T>>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:126
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:127

`Static`throughDOM

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

`Static`throughNode

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

Class RecordBatchWriter<T>

Type Parameters

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RecordBatchWriter<T>

Accessors

closed

Returns Promise<void>

Methods

[asyncIterator]

Returns AsyncByteQueue<Uint8Array>

abort

Parameters

Returns void

close

Returns void

finish

Returns RecordBatchWriter<T>

pipe

Type Parameters

Parameters

Returns R

pipeThrough

Type Parameters

Parameters

Returns ReadableStream<any>

pipeTo

Parameters

Returns Promise<void>

reset

Parameters

Returns RecordBatchWriter<T>

tee

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

toDOMStream

Parameters

Returns ReadableStream<Uint8Array>

toNodeStream

Parameters

Returns Readable

toString

Parameters

Returns string

Parameters

Returns Promise<string>

toUint8Array

Parameters

Returns Uint8Array

Parameters

Returns Promise<Uint8Array>

write

Parameters

Returns void

Parameters

Returns void

writeAll

Parameters

Returns this

Parameters

Returns Promise<RecordBatchWriter<T>>

Parameters

Returns Promise<RecordBatchWriter<T>>

Parameters

Returns Promise<RecordBatchWriter<T>>

StaticthroughDOM

Type Parameters

Parameters

Returns { readable: ReadableStream<Uint8Array>; writable: WritableStream<RecordBatch<T> | Table<T>>;}

Nocollapse

StaticthroughNode

Parameters

Returns Duplex

Nocollapse

`Static`throughDOM

Returns {
readable: ReadableStream<Uint8Array>;
writable: WritableStream<RecordBatch<T> | Table<T>>;
}

`Static`throughNode