Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordBatchWriter<T>

Type parameters

  • T: {} = any

Hierarchy

  • ReadableInterop<Uint8Array>
    • RecordBatchWriter

Implements

  • Writable<RecordBatch<T>>

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

closed

  • get closed(): Promise<void>

Methods

[Symbol.asyncIterator]

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

abort

  • abort(reason?: any): void

close

  • close(): void

finish

  • finish(): this

pipe

  • pipe<R>(writable: R, options?: undefined | { end?: undefined | false | true }): R

  • Type parameters

    • R: WritableStream

    Parameters

    • writable: R
    • Optional options: undefined | { end?: undefined | false | true }

    Returns R

pipeThrough

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

  • Type parameters

    • R: ReadableStream<any>

    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>

  • Parameters

    • writable: WritableStream<Uint8Array>
    • Optional options: PipeOptions

    Returns Promise<void>

reset

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

  • Parameters

    • Default value sink: WritableSink<ArrayBufferViewInput> = this._sink
    • Default value schema: Schema<T> | null = null

    Returns this

tee

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

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

toDOMStream

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

  • Parameters

    • Optional options: ReadableDOMStreamOptions

    Returns ReadableStream<Uint8Array>

toNodeStream

  • toNodeStream(options?: undefined | ReadableOptions): Readable

  • Parameters

    • Optional options: undefined | ReadableOptions

    Returns Readable

toString

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

toUint8Array

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

write

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

  • Parameters

    • Optional payload: Table<T> | RecordBatch<T> | Iterable<RecordBatch<T>> | null

    Returns void

writeAll

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

Static throughDOM

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

    Type parameters

    • T: {}

    Parameters

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

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

    • readable: ReadableStream<Uint8Array>
    • writable: WritableStream<Table<T> | RecordBatch<T>>

Static throughNode

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

    Parameters

    • Optional options: DuplexOptions & { autoDestroy: boolean }

    Returns Duplex

Generated using TypeDoc