Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordBatchWriter<T>

Type parameters

  • T: TypeMap = any

Hierarchy

  • ReadableInterop<Uint8Array>
    • RecordBatchWriter

Implements

  • Writable<RecordBatch<T>>

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new RecordBatchWriter<T>(options?: RecordBatchStreamWriterOptions): RecordBatchWriter<T>

  • Type parameters

    • T: TypeMap = any

    Parameters

    • Optional options: RecordBatchStreamWriterOptions

    Returns RecordBatchWriter<T>

Accessors

closed

  • get closed(): Promise<void>

Methods

[asyncIterator]

  • [asyncIterator](): AsyncByteQueue<Uint8Array>

abort

  • abort(reason?: any): void

  • Parameters

    • Optional reason: any

    Returns void

close

  • close(): void

finish

pipe

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

  • Type parameters

    • R: WritableStream<R>

    Parameters

    • writable: R
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns R

pipeThrough

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

  • Type parameters

    • R: ReadableStream<any, R>

    Parameters

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

    Returns ReadableStream<any>

pipeTo

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

  • Parameters

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

    Returns Promise<void>

reset

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?: ReadableOptions): Readable

  • Parameters

    • Optional options: ReadableOptions

    Returns Readable

toString

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

toUint8Array

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

write

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

  • Parameters

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

    Returns void

writeAll

Static throughDOM

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

    Type parameters

    • T: TypeMap

    Parameters

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

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

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

Static throughNode

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

    Parameters

    • Optional options: DuplexOptions & { autoDestroy: boolean }

    Returns Duplex

Generated using TypeDoc