類別 RecordBatchWriter<T>

類型參數

  • T extends TypeMap = any

層級結構

  • ReadableInterop<Uint8Array>
    • 紀錄批次寫入器

實作

  • Writable<RecordBatch<T>>

建構子

constructor

存取器

closed

方法

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

建構子

建構子

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

  • 類型參數

    • T extends TypeMap = any

    參數

    • 選填options: RecordBatchStreamWriterOptions

    回傳 RecordBatchWriter<T>

存取器

closed

  • get closed(): Promise<void>

  • 回傳 Promise<void>

方法

[asyncIterator]

  • "[asyncIterator]"(): AsyncByteQueue

  • 回傳 AsyncByteQueue

abort

  • abort(reason?: any): void

  • 參數

    • 選填reason: any

    回傳 void

close

  • close(): void

  • 回傳 void

finish

pipe

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

  • 類型參數

    • R extends WritableStream

    參數

    • writable: R
    • 選填options: { end?: boolean }

    回傳 R

pipeThrough

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

  • 類型參數

    • R extends ReadableStream

    參數

    • duplex: { readable: R; writable: WritableStream<Uint8Array> }
    • 選填options: StreamPipeOptions

    回傳 ReadableStream

pipeTo

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

  • 參數

    • writable: WritableStream<Uint8Array>
    • 選填options: StreamPipeOptions

    回傳 Promise<void>

reset

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

  • 參數

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

    回傳 RecordBatchWriter<T>

tee

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

  • 回傳 [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]

toDOMStream

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

  • 參數

    • 選填options: ReadableDOMStreamOptions

    回傳 ReadableStream<Uint8Array>

toNodeStream

  • toNodeStream(options?: ReadableOptions): Readable

  • 參數

    • 選填options: ReadableOptions

    回傳 Readable

toString

  • toString(sync: true): string

  • 回傳物件的字串表示形式。

    參數

    • sync: true

    回傳 string

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

  • 參數

    • 選填sync: false

    回傳 Promise<string>

toUint8Array

  • toUint8Array(sync: true): Uint8Array

  • 參數

    • sync: true

    回傳 Uint8Array

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

  • 參數

    • 選填sync: false

    回傳 Promise<Uint8Array>

write

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

  • 參數

    • 選填payload: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>

    回傳 void

writeAll

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

  • 參數

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

    回傳 this

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

  • 參數

    • input: AsyncIterable<RecordBatch<T>>

    回傳 Promise<RecordBatchWriter<T>>

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

  • 參數

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

    回傳 Promise<RecordBatchWriter<T>>

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

  • 參數

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

    回傳 Promise<RecordBatchWriter<T>>

靜態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>>;
    }

  • 類型參數

    • T extends TypeMap

    參數

    • 選填writableStrategy: QueuingStrategy<RecordBatch<T>> & { autoDestroy: boolean }
    • 選填readableStrategy: { highWaterMark?: number; size?: any }

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

    Nocollapse

靜態throughNode

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

  • 參數

    • 選填options: DuplexOptions & { autoDestroy: boolean }

    回傳 Duplex

    Nocollapse

設定

成員可見性

本頁面

建構子
存取器
方法