Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordBatchWriter<T>

Type parameters

  • T: object

Hierarchy

  • ReadableInterop<Uint8Array>
    • RecordBatchWriter

Implements

  • Writable<RecordBatch<T>>

Index

Constructors

constructor

Accessors

closed

closed:

Methods

__@asyncIterator

  • __@asyncIterator(): AsyncByteQueue<Uint8Array>

abort

  • abort(reason: any): void

close

  • close(): void

finish

  • finish(): this

pipe

  • pipe<R>(writable: R, options: undefined | object): R
  • Type parameters

    • R: WritableStream

    Parameters

    • writable: R
    • Optional options: undefined | object

    Returns R

pipeThrough

  • pipeThrough<R>(duplex: object, options: PipeOptions): ReadableStream<any>
  • Type parameters

    • R: ReadableStream<any>

    Parameters

    • duplex: object
    • 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>
  • Parameters

    • sync: true

    Returns string

  • Parameters

    • Optional sync: undefined | false

    Returns Promise<string>

toUint8Array

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

    • sync: true

    Returns Uint8Array

  • Parameters

    • Optional sync: undefined | false

    Returns 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>
  • Parameters

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

    Returns this

  • Parameters

    • input: AsyncIterable<RecordBatch<T>>

    Returns Promise<this>

  • Parameters

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

    Returns Promise<this>

  • Parameters

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

    Returns Promise<this>

Static throughDOM

  • throughDOM<T>(writableStrategy: QueuingStrategy<RecordBatch<T>> & object, readableStrategy: undefined | object): object
  • Type parameters

    • T: object

    Parameters

    • Optional writableStrategy: QueuingStrategy<RecordBatch<T>> & object
    • Optional readableStrategy: undefined | object

    Returns object

Static throughNode

  • throughNode(options: DuplexOptions & object): Duplex
  • Parameters

    • Optional options: DuplexOptions & object

    Returns Duplex

Generated using TypeDoc