Class RecordBatchWriter<T>

Type Parameters

  • T extends TypeMap = any

Hierarchy

  • ReadableInterop<Uint8Array>
    • RecordBatchWriter

Implements

  • Writable<RecordBatch<T>>

Constructors

constructor

Accessors

closed

Methods

[asyncIterator] abort close finish pipe pipeThrough pipeTo reset tee toDOMStream toNodeStream toString toUint8Array write writeAll throughDOM throughNode

Constructors

constructor

  • new RecordBatchWriter<T extends TypeMap = any>(
        options?: RecordBatchStreamWriterOptions,
    ): RecordBatchWriter<T>

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • Optionaloptions: RecordBatchStreamWriterOptions

    Returns RecordBatchWriter<T>

Accessors

closed

  • get closed(): Promise<void>

  • Returns Promise<void>

Methods

[asyncIterator]

  • "[asyncIterator]"(): AsyncByteQueue

  • Returns AsyncByteQueue

abort

  • abort(reason?: any): void

  • Parameters

    • Optionalreason: any

    Returns void

close

  • close(): void

  • Returns void

finish

pipe

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

  • Type Parameters

    • R extends WritableStream

    Parameters

    • writable: R
    • Optionaloptions: { end?: boolean }

    Returns R

pipeThrough

  • pipeThrough<R extends ReadableStream>(
        duplex: { readable: R; writable: WritableStream<Uint8Array> },
        options?: StreamPipeOptions,
    ): ReadableStream

  • Type Parameters

    • R extends ReadableStream

    Parameters

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

    Returns ReadableStream

pipeTo

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

  • Parameters

    • writable: WritableStream<Uint8Array>
    • Optionaloptions: StreamPipeOptions

    Returns Promise<void>

reset

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

  • Parameters

    • sink: WritableSink<ArrayBufferViewInput> = ...
    • schema: null | Schema<T> = null

    Returns RecordBatchWriter<T>

tee

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

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

toDOMStream

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

  • Parameters

    • Optionaloptions: ReadableDOMStreamOptions

    Returns ReadableStream<Uint8Array>

toNodeStream

  • toNodeStream(options?: ReadableOptions): Readable

  • Parameters

    • Optionaloptions: ReadableOptions

    Returns Readable

toString

  • toString(sync: true): string

  • Returns a string representation of an object.

    Parameters

    • sync: true

    Returns string

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

  • Parameters

    • Optionalsync: false

    Returns Promise<string>

toUint8Array

  • toUint8Array(sync: true): Uint8Array

  • Parameters

    • sync: true

    Returns Uint8Array

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

  • Parameters

    • Optionalsync: false

    Returns Promise<Uint8Array>

write

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

  • Parameters

    • Optionalpayload: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>

    Returns void

writeAll

  • writeAll(input: Table<T> | Iterable<RecordBatch<T>>): this

  • Parameters

    • input: Table<T> | Iterable<RecordBatch<T>>

    Returns this

  • writeAll(input: AsyncIterable<RecordBatch<T>>): Promise<RecordBatchWriter<T>>

  • Parameters

    • input: AsyncIterable<RecordBatch<T>>

    Returns Promise<RecordBatchWriter<T>>

  • writeAll(
        input: PromiseLike<AsyncIterable<RecordBatch<T>>>,
    ): Promise<RecordBatchWriter<T>>

  • Parameters

    • input: PromiseLike<AsyncIterable<RecordBatch<T>>>

    Returns Promise<RecordBatchWriter<T>>

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

  • Parameters

    • input: PromiseLike<Table<T> | Iterable<RecordBatch<T>>>

    Returns Promise<RecordBatchWriter<T>>

StaticthroughDOM

  • 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

StaticthroughNode

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

  • Parameters

    • Optionaloptions: DuplexOptions & { autoDestroy: boolean }

    Returns Duplex

    Nocollapse

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods