类 RecordBatchReader<T>

类型参数

T extends TypeMap = any

层级

ReadableInterop<RecordBatch<T>>
- RecordBatchReader

访问器

autoDestroy

get autoDestroy(): boolean
返回 boolean
- 定义于 ipc/reader.ts:80

closed

get closed(): boolean
返回 boolean
- 定义于 ipc/reader.ts:78

dictionaries

get dictionaries(): Map<number, Vector<any>>
返回 Map<number, Vector<any>>
- 定义于 ipc/reader.ts:81

get footer(): null | Footer_
返回 null | Footer_
- 定义于 ipc/reader.ts:84

numDictionaries

get numDictionaries(): number
返回 number
- 定义于 ipc/reader.ts:82

numRecordBatches

get numRecordBatches(): number
返回 number
- 定义于 ipc/reader.ts:83

schema

get schema(): Schema<T>
返回 Schema<T>
- 定义于 ipc/reader.ts:79

方法

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<RecordBatch<T>>
返回 AsyncIterableIterator<RecordBatch<T>>
- 定义于 ipc/reader.ts:119

[迭代器]

"[iterator]"(): IterableIterator<RecordBatch<T>>
返回 IterableIterator<RecordBatch<T>>
- 定义于 ipc/reader.ts:116

cancel

cancel(): void | Promise<void>
返回 void | Promise<void>
- 定义于 ipc/reader.ts:100

isAsync

isAsync(): this is AsyncRecordBatchReaders<T>
返回 this is AsyncRecordBatchReaders<T>
- 定义于 ipc/reader.ts:87

isFile

isFile(): this is RecordBatchFileReaders<T>
返回 this is RecordBatchFileReaders<T>
- 定义于 ipc/reader.ts:88

isStream

isStream(): this is RecordBatchStreamReaders<T>
返回 this is RecordBatchStreamReaders<T>
- 定义于 ipc/reader.ts:89

isSync

isSync(): this is RecordBatchReaders<T>
返回 this is RecordBatchReaders<T>
- 定义于 ipc/reader.ts:86

next(): Promise<any> | IteratorResult<RecordBatch<T>, any>
返回 Promise<any> | IteratorResult<RecordBatch<T>, any>
- 定义于 ipc/reader.ts:91

open

open(
options?: OpenOptions,
): RecordBatchReader<T> | Promise<RecordBatchReader<T>>
参数
- Optionaloptions: OpenOptions
返回 RecordBatchReader<T> | Promise<RecordBatchReader<T>>
- 定义于 ipc/reader.ts:109

pipe

pipe<R extends WritableStream>(writable: R, options?: { end?: boolean }): R
类型参数
- R extends WritableStream
参数
- writable: R
- Optionaloptions: { end?: boolean }
返回 R
继承自 ReadableInterop.pipe
- 定义于 io/interfaces.ts:77

pipeThrough

pipeThrough<R extends ReadableStream<any>>(
duplex: { readable: R; writable: WritableStream<RecordBatch<T>> },
options?: StreamPipeOptions,
): ReadableStream<any>
类型参数
- R extends ReadableStream<any>
参数
- duplex: { readable: R; writable: WritableStream<RecordBatch<T>> }
- Optionaloptions: StreamPipeOptions
返回 ReadableStream<any>
继承自 ReadableInterop.pipeThrough
- 定义于 io/interfaces.ts:81

pipeTo

pipeTo(
writable: WritableStream<RecordBatch<T>>,
options?: StreamPipeOptions,
): Promise<void>
参数
- writable: WritableStream<RecordBatch<T>>
- Optionaloptions: StreamPipeOptions
返回 Promise<void>
继承自 ReadableInterop.pipeTo
- 定义于 io/interfaces.ts:80

readRecordBatch

readRecordBatch(
index: number,
): null | RecordBatch<T> | Promise<null | RecordBatch<T>>
参数
- index: number
返回 null | RecordBatch<T> | Promise<null | RecordBatch<T>>
- 定义于 ipc/reader.ts:113

reset

reset(schema?: null | Schema<T>): this
参数
- Optionalschema: null | Schema<T>
返回 this
- 定义于 ipc/reader.ts:103

return

return(
value?: any,
): IteratorResult<any, any> | Promise<IteratorResult<any, any>>
参数
- Optionalvalue: any
返回 IteratorResult<any, any> | Promise<IteratorResult<any, any>>
- 定义于 ipc/reader.ts:97

tee

tee(): [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]
返回 [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]
继承自 ReadableInterop.tee
- 定义于 io/interfaces.ts:74

throw

throw(value?: any): IteratorResult<any, any> | Promise<IteratorResult<any, any>>
参数
- Optionalvalue: any
返回 IteratorResult<any, any> | Promise<IteratorResult<any, any>>
- 定义于 ipc/reader.ts:94

toDOMStream

toDOMStream(): ReadableStream<RecordBatch<T>>
返回 ReadableStream<RecordBatch<T>>
覆盖 ReadableInterop.toDOMStream
- 定义于 ipc/reader.ts:122

toNodeStream

toNodeStream(): Readable
返回 Readable
覆盖 ReadableInterop.toNodeStream
- 定义于 ipc/reader.ts:128

`Static`from

from<T extends RecordBatchReader<any>>(source: T): T
类型参数
- T extends RecordBatchReader<any>
参数
- source: T
返回 T
- 定义于 ipc/reader.ts:151
from<T extends TypeMap = any>(source: ArrowJSONLike): RecordBatchStreamReader<T>
类型参数
- T extends TypeMap = any
参数
- source: ArrowJSONLike
返回 RecordBatchStreamReader<T>
- 定义于 ipc/reader.ts:152
from<T extends TypeMap = any>(
source: FromArg1,
): Promise<RecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg1
返回 Promise<RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:153
from<T extends TypeMap = any>(
source: FromArg2,
): RecordBatchFileReader<T> | RecordBatchStreamReader<T>
类型参数
- T extends TypeMap = any
参数
- source: FromArg2
返回 RecordBatchFileReader<T> | RecordBatchStreamReader<T>
- 定义于 ipc/reader.ts:154
from<T extends TypeMap = any>(
source: FromArg3,
): Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg3
返回 Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:155
from<T extends TypeMap = any>(
source: FromArg4,
): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg4
返回 Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:156
from<T extends TypeMap = any>(
source: FromArg5,
): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg5
返回 Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:157

`Static`readAll

readAll<T extends RecordBatchReader<any>>(
    source: T,
): T extends RecordBatchReaders<any>
    ? IterableIterator<T<T>>
    : AsyncIterableIterator<T>
类型参数
- T extends RecordBatchReader<any>
参数
- source: T
返回 T extends RecordBatchReaders<any>
? IterableIterator<T<T>>
: AsyncIterableIterator<T>
- 定义于 ipc/reader.ts:174
readAll<T extends TypeMap = any>(
source: ArrowJSONLike,
): IterableIterator<RecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: ArrowJSONLike
返回 IterableIterator<RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:175
readAll<T extends TypeMap = any>(
source: FromArg1,
): AsyncIterableIterator<RecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg1
返回 AsyncIterableIterator<RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:176
readAll<T extends TypeMap = any>(
source: FromArg2,
): IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg2
返回 IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:177
readAll<T extends TypeMap = any>(
    source: FromArg3,
): AsyncIterableIterator<
    RecordBatchFileReader<T>
    | RecordBatchStreamReader<T>,
>
类型参数
- T extends TypeMap = any
参数
- source: FromArg3
返回 AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- 定义于 ipc/reader.ts:178
readAll<T extends TypeMap = any>(
source: FromArg4,
): AsyncIterableIterator<AsyncRecordBatchReaders<T>>
类型参数
- T extends TypeMap = any
参数
- source: FromArg4
返回 AsyncIterableIterator<AsyncRecordBatchReaders<T>>
- 定义于 ipc/reader.ts:179
readAll<T extends TypeMap = any>(
source: FromArg5,
source: FromArg5,
类型参数
- T extends TypeMap = any
参数
- source: FromArg5
): AsyncIterableIterator<AsyncRecordBatchReaders<T>>
- 定义于 ipc/reader.ts:180

`静态`throughDOM

throughDOM<T extends TypeMap>(
    writableStrategy?: ByteLengthQueuingStrategy,
    readableStrategy?: { autoDestroy: boolean },
): {
    readable: ReadableStream<RecordBatch<T>>;
    writable: WritableStream<Uint8Array>;
}
类型参数
- T extends TypeMap
参数
- OptionalwritableStrategy: ByteLengthQueuingStrategy
- OptionalreadableStrategy: { autoDestroy: boolean }
返回 {
readable: ReadableStream<RecordBatch<T>>;
writable: WritableStream<Uint8Array>;
}
Nocollapse
- 定义于 ipc/reader.ts:142

`静态`throughNode

throughNode(options?: DuplexOptions<Duplex> & { autoDestroy: boolean }): Duplex
参数
- Optionaloptions: DuplexOptions<Duplex> & { autoDestroy: boolean }
返回 Duplex
Nocollapse
- 定义于 ipc/reader.ts:138

类 RecordBatchReader<T>

类型参数

层级

索引

访问器

方法

访问器

autoDestroy

返回 boolean

closed

返回 boolean

dictionaries

返回 Map<number, Vector<any>>

footer

返回 null | Footer_

numDictionaries

返回 number

numRecordBatches

返回 number

schema

返回 Schema<T>

方法

[asyncIterator]

返回 AsyncIterableIterator<RecordBatch<T>>

[迭代器]

返回 IterableIterator<RecordBatch<T>>

cancel

返回 void | Promise<void>

isAsync

返回 this is AsyncRecordBatchReaders<T>

isFile

返回 this is RecordBatchFileReaders<T>

isStream

返回 this is RecordBatchStreamReaders<T>

isSync

返回 this is RecordBatchReaders<T>

next

返回 Promise<any> | IteratorResult<RecordBatch<T>, any>

open

参数

返回 RecordBatchReader<T> | Promise<RecordBatchReader<T>>

pipe

类型参数

参数

返回 R

pipeThrough

类型参数

参数

返回 ReadableStream<any>

pipeTo

参数

返回 Promise<void>

readRecordBatch

参数

返回 null | RecordBatch<T> | Promise<null | RecordBatch<T>>

reset

参数

返回 this

return

参数

返回 IteratorResult<any, any> | Promise<IteratorResult<any, any>>

tee

返回 [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]

throw

参数

返回 IteratorResult<any, any> | Promise<IteratorResult<any, any>>

toDOMStream

返回 ReadableStream<RecordBatch<T>>

toNodeStream

返回 Readable

Staticfrom

类型参数

参数

返回 T

类型参数

参数

返回 RecordBatchStreamReader<T>

类型参数

参数

返回 Promise<RecordBatchStreamReader<T>>

`Static`from

`Static`readAll

返回 T extends RecordBatchReaders<any>
? IterableIterator<T<T>>
: AsyncIterableIterator<T>

`静态`throughDOM

返回 {
readable: ReadableStream<RecordBatch<T>>;
writable: WritableStream<Uint8Array>;
}

`静态`throughNode