Class: DatabaseNames¶

A lazy async iterator of database names with pagination state. Returned by Catalog.listDatabases.

Implements¶

AsyncIterableIterator<string>

Methods¶

[asyncIterator]()¶

asyncIterator: AsyncIterableIterator<string>

Returns¶

AsyncIterableIterator<string>

Implementation of¶

AsyncIterableIterator.[asyncIterator]

next()¶

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

Fetch the next name, requesting another page only when needed.

Returns¶

Promise<IteratorResult<string, any>>

Implementation of¶

AsyncIterableIterator.next

numPageResults()¶

numPageResults(): number

Number of names available without another REST request.

Returns¶

number

pageToken()¶

pageToken(): undefined | string

Token for the next REST request. Initially this is the supplied starting token. Returns undefined after the final page is fetched, even if names remain cached. Drain the cache before saving a token to avoid skipping names when resuming. A failed request terminates iteration and retains its token for a new iterator.

Returns¶

undefined | string