类 RecordBatchWriter<T>

类型参数

  • T extends TypeMap = any

层级结构

  • ReadableInterop<Uint8Array>
    • RecordBatchWriter

实现

  • Writable<RecordBatch<T>>

构造函数

constructor

访问器

closed

方法

[异步迭代器] 中止 关闭 完成 管道 管道传输 管道到 重置 T型分支 转换为 DOM 流 转换为 Node 流 转换为字符串 转换为 Uint8Array 写入 全部写入 通过 DOM 通过 Node

构造函数

构造函数

  • 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]"(): AsyncByteQueue

  • 返回 AsyncByteQueue

中止

  • abort(reason?: any): void

  • 参数

    • 可选reason: any

    返回 void

关闭

  • close(): void

  • 返回 void

完成

管道

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

  • 类型参数

    • R extends WritableStream

    参数

    • writable: R
    • 可选options: { end?: boolean }

    返回 R

管道传输

  • 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(
        writable: WritableStream<Uint8Array>,
        options?: StreamPipeOptions,
    ): Promise<void>

  • 参数

    • 可写: WritableStream<Uint8Array>
    • 可选options: StreamPipeOptions

    返回 Promise<void>

重置

  • 重置(
        接收器?: WritableSink<ArrayBufferViewInput>,
        模式?: null | Schema<T>,
    ): RecordBatchWriter<T>

  • 参数

    • 接收器: WritableSink<ArrayBufferViewInput> = ...
    • 模式: null | Schema<T> = null

    返回 RecordBatchWriter<T>

tee

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

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

转换为 DOM 流

  • 转换为 DOM 流(选项?: ReadableDOMStreamOptions): ReadableStream<Uint8Array>

  • 参数

    • 可选选项: ReadableDOMStreamOptions

    返回 ReadableStream<Uint8Array>

转换为Node流

  • 转换为Node流(选项?: ReadableOptions): Readable

  • 参数

    • 可选选项: ReadableOptions

    返回 Readable

转换为字符串

  • 转换为字符串(同步: true): string

  • 返回对象的字符串表示形式。

    参数

    • 同步: true

    返回 string

  • 转换为字符串(同步?: false): Promise<string>

  • 参数

    • 可选同步: false

    返回 Promise<string>

转换为 Uint8Array

  • 转换为Uint8Array(同步: true): Uint8Array

  • 参数

    • 同步: true

    返回 Uint8Array

  • 转换为Uint8Array(同步?: false): Promise<Uint8Array>

  • 参数

    • 可选同步: false

    返回 Promise<Uint8Array>

写入

  • 写入(
        负载?: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>,
    ): void

  • 参数

    • 可选负载: null | RecordBatch<T> | Table<T> | Iterable<RecordBatch<T>>

    返回 void

全部写入

  • 全部写入(输入: Table<T> | Iterable<RecordBatch<T>>): this

  • 参数

    • 输入: Table<T> | Iterable<RecordBatch<T>>

    返回 this

  • 全部写入(输入: AsyncIterable<RecordBatch<T>>): Promise<RecordBatchWriter<T>>

  • 参数

    • 输入: 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

设置

成员可见性

在本页

构造函数
访问器
方法