Class KeySet<K, V>`Internal`

A pageable collection of keys based on the provided NamedCache<K, V>.

Type Parameters

K

the key type of the named cache
V

the value type of the named cache

Hierarchy

PagedSet<K, V, K>
- KeySet

Index

Constructors

Properties

[toStringTag] namedCache

Accessors

Methods

[asyncIterator] [iterator] clear delete has

Constructors

constructor

new KeySet<K, V>(namedCache: NamedCacheClient<K, V>): KeySet<K, V>
Constructs a new KeySet.
Type Parameters
- K
- V
Parameters
- namedCache: NamedCacheClient<K, V>
  
  the NamedCache to page through
Returns KeySet<K, V>

Overrides PagedSet<K, V, K>.constructor

Properties

[toStringTag]

[toStringTag]: string = 'KeySet'

`Protected` `Readonly` namedCache

namedCache: NamedCacheClient<K, V>

NamedCache reference to allow the manipulation of an underlying cache while pages are processed.

Accessors

size

get size(): Promise<number>
Inherit Doc

Returns Promise<number>

Inherited from PagedSet.size

Methods

[asyncIterator]

[asyncIterator](): PageAdvancer<unknown, unknown, BytesValue, K>
Returns an async iterator for paging.

Returns
an async iterator for paging

Returns PageAdvancer<unknown, unknown, BytesValue, K>

[iterator]

[iterator](): IterableIterator<K>
Inherit Doc

Returns IterableIterator<K>

Inherited from PagedSet.__@iterator@85

clear

clear(): Promise<boolean>
This is an unsupported operation.

Returns Promise<boolean>

Inherited from PagedSet.clear

delete

delete(key: K): Promise<boolean>
Inherit Doc
Parameters
- key: K
Returns Promise<boolean>

Overrides PagedSet.delete

has

has(key: K): Promise<boolean>
Inherit Doc
Parameters
- key: K
Returns Promise<boolean>

Overrides PagedSet.has