Class RecordBatchWriter<T>

Type Parameters

T extends TypeMap = any

Hierarchy

ReadableInterop<Uint8Array>
- RecordBatchWriter

Implements

Writable<RecordBatch<T>>

Index

Constructors

constructor

new RecordBatchWriter<T>(options?): RecordBatchWriter<T>
Type Parameters
- T extends TypeMap = any
Parameters
- Optionaloptions: RecordBatchStreamWriterOptions
Returns RecordBatchWriter<T>
Overrides ReadableInterop<Uint8Array>.constructor
- Defined in ipc/writer.ts:71

Accessors

closed

get closed(): Promise<void>
Returns Promise<void>
Implementation of Writable.closed
- Defined in ipc/writer.ts:114

Methods

[asyncIterator]

[asyncIterator](): AsyncByteQueue<Uint8Array>
Returns AsyncByteQueue<Uint8Array>
- Defined in ipc/writer.ts:115

abort

abort(reason?): void
Parameters
- Optionalreason: any
Returns void
Implementation of Writable.abort
- Defined in ipc/writer.ts:122

close

close(): void
Returns void
Implementation of Writable.close
- Defined in ipc/writer.ts:119

finish

finish(): RecordBatchWriter<T>
Returns RecordBatchWriter<T>
- Defined in ipc/writer.ts:125

pipe

pipe<R>(writable, options?): R
Type Parameters
- R extends WritableStream
Parameters
- writable: R
- Optionaloptions: {
  end?: boolean;
  }
  - Optionalend?: boolean
Returns R
Inherited from ReadableInterop.pipe
- Defined in io/interfaces.ts:76

pipeThrough

pipeThrough<R>(duplex, options?): ReadableStream<any>
Type Parameters
- R extends ReadableStream<any>
Parameters
- duplex: {
  readable: R;
  writable: WritableStream<Uint8Array>;
  }
  - readable: R
  - writable: WritableStream<Uint8Array>
- Optionaloptions: StreamPipeOptions
Returns ReadableStream<any>
Inherited from ReadableInterop.pipeThrough
- Defined in io/interfaces.ts:80

pipeTo

pipeTo(writable, options?): Promise<void>
Parameters
- writable: WritableStream<Uint8Array>
- Optionaloptions: StreamPipeOptions
Returns Promise<void>
Inherited from ReadableInterop.pipeTo
- Defined in io/interfaces.ts:79

reset

reset(sink?, schema?): RecordBatchWriter<T>
Parameters
- sink: WritableSink<ArrayBufferViewInput> = ...
- schema: null | Schema<T> = null
Returns RecordBatchWriter<T>
- Defined in ipc/writer.ts:129

tee

tee(): [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]
Returns [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]
Inherited from ReadableInterop.tee
- Defined in io/interfaces.ts:73

toDOMStream

toDOMStream(options?): ReadableStream<Uint8Array>
Parameters
- Optionaloptions: ReadableDOMStreamOptions
Returns ReadableStream<Uint8Array>
Overrides ReadableInterop.toDOMStream
- Defined in ipc/writer.ts:116

toNodeStream

toNodeStream(options?): Readable
Parameters
- Optionaloptions: ReadableOptions
Returns Readable
Overrides ReadableInterop.toNodeStream
- Defined in ipc/writer.ts:117

toString

toString(sync): string
Returns a string representation of an object.
Parameters
- sync: true
Returns string
- Defined in ipc/writer.ts:90
toString(sync?): Promise<string>
Returns a string representation of an object.
Parameters
- Optionalsync: false
Returns Promise<string>
- Defined in ipc/writer.ts:91

toUint8Array

toUint8Array(sync): Uint8Array
Parameters
- sync: true
Returns Uint8Array
- Defined in ipc/writer.ts:95
toUint8Array(sync?): Promise<Uint8Array>
Parameters
- Optionalsync: false
Returns Promise<Uint8Array>
- Defined in ipc/writer.ts:96

write

write(payload?): void
Parameters
- Optionalpayload:
      | null
      | RecordBatch<T>
      | Table<T>
      | Iterable<RecordBatch<T>>
Returns void
Implementation of Writable.write
- Defined in ipc/writer.ts:165

writeAll

writeAll(input): this
Parameters
- input: Table<T> | Iterable<RecordBatch<T>>
Returns this
- Defined in ipc/writer.ts:101
writeAll(input): Promise<RecordBatchWriter<T>>
Parameters
- input: AsyncIterable<RecordBatch<T>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:102
writeAll(input): Promise<RecordBatchWriter<T>>
Parameters
- input: PromiseLike<AsyncIterable<RecordBatch<T>>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:103
writeAll(input): Promise<RecordBatchWriter<T>>
Parameters
- input: PromiseLike<Table<T> | Iterable<RecordBatch<T>>>
Returns Promise<RecordBatchWriter<T>>
- Defined in ipc/writer.ts:104

`Static`throughDOM

throughDOM<T>(writableStrategy?, readableStrategy?): {
readable: ReadableStream<Uint8Array>;
writable: WritableStream<RecordBatch<T> | Table<T>>;
}
Type Parameters
- T extends TypeMap
Parameters
- OptionalwritableStrategy: QueuingStrategy<RecordBatch<T>> & {
  autoDestroy: boolean;
  }
- OptionalreadableStrategy: {
  highWaterMark?: number;
  size?: any;
  }
  - OptionalhighWaterMark?: number
  - Optionalsize?: any
Returns {
readable: ReadableStream<Uint8Array>;
writable: WritableStream<RecordBatch<T> | Table<T>>;
}
- readable: ReadableStream<Uint8Array>
- writable: WritableStream<RecordBatch<T> | Table<T>>
Nocollapse
- Defined in ipc/writer.ts:62

`Static`throughNode

throughNode(options?): Duplex
Parameters
- Optionaloptions: DuplexOptions & {
  autoDestroy: boolean;
  }
Returns Duplex
Nocollapse
- Defined in ipc/writer.ts:58

Class RecordBatchWriter<T>

Type Parameters

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RecordBatchWriter<T>

Accessors

closed

Returns Promise<void>

Methods

[asyncIterator]

Returns AsyncByteQueue<Uint8Array>

abort

Parameters

Returns void

close

Returns void

finish

Returns RecordBatchWriter<T>

pipe

Type Parameters

Parameters

Optionalend?: boolean

Returns R

pipeThrough

Type Parameters

Parameters

readable: R

writable: WritableStream<Uint8Array>

Returns ReadableStream<any>

pipeTo

Parameters

Returns Promise<void>

reset

Parameters

Returns RecordBatchWriter<T>

tee

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

toDOMStream

Parameters

Returns ReadableStream<Uint8Array>

toNodeStream

Parameters

Returns Readable

toString

Parameters

Returns string

Parameters

Returns Promise<string>

toUint8Array

Parameters

Returns Uint8Array

Parameters

Returns Promise<Uint8Array>

write

Parameters

Returns void

writeAll

Parameters

Returns this

Parameters

Returns Promise<RecordBatchWriter<T>>

Parameters

Returns Promise<RecordBatchWriter<T>>

Parameters

Returns Promise<RecordBatchWriter<T>>

StaticthroughDOM

Type Parameters

Parameters

OptionalhighWaterMark?: number

Optionalsize?: any

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

readable: ReadableStream<Uint8Array>

`Optional`end?: boolean

`Static`throughDOM

`Optional`highWaterMark?: number

`Optional`size?: any

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

`Static`throughNode