Files
lancedb/docs/src/js/classes/RecordBatchIterator.md
Weston Pace 67f041be91 docs: add a reference to @lancedb/lance in the docs (#1166)
We aren't yet ready to switch over the examples since almost all JS
examples rely on embeddings and we haven't yet ported those over.
However, this makes it possible for those that are interested to start
using `@lancedb/lancedb`
2024-03-29 04:55:03 -07:00

1.5 KiB

@lancedb/lancedb / Exports / RecordBatchIterator

Class: RecordBatchIterator

Implements

  • AsyncIterator<RecordBatch>

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RecordBatchIterator(promise?): RecordBatchIterator

Parameters

Name Type
promise? Promise<RecordBatchIterator>

Returns

RecordBatchIterator

Defined in

query.ts:27

Properties

inner

Private Optional inner: RecordBatchIterator

Defined in

query.ts:25


promisedInner

Private Optional promisedInner: Promise<RecordBatchIterator>

Defined in

query.ts:24

Methods

next

next(): Promise<IteratorResult<RecordBatch<any>, any>>

Returns

Promise<IteratorResult<RecordBatch<any>, any>>

Implementation of

AsyncIterator.next

Defined in

query.ts:33