Class EntrySet<K, V>`Internal`

A pageable collection of MapEntrys 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, MapEntry<K, V>>
- EntrySet

Index

Constructors

Properties

[toStringTag] namedCache

Accessors

Methods

[asyncIterator] [iterator] clear delete has

Constructors

constructor

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

Overrides PagedSet<K, V, MapEntry<K, V>>.constructor

Properties

[toStringTag]

[toStringTag]: string = 'EntrySet'

`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, EntryResult, MapEntry<K, V>>
Returns an async iterator for paging.

Returns
an async iterator for paging

Returns PageAdvancer<unknown, unknown, EntryResult, MapEntry<K, V>>

[iterator]

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

Returns IterableIterator<MapEntry<K, V>>

Inherited from PagedSet.__@iterator@85

clear

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

Returns Promise<boolean>

Inherited from PagedSet.clear

delete

delete(e: MapEntry<K, V>): Promise<boolean>
Inherit Doc
Parameters
- e: MapEntry<K, V>
Returns Promise<boolean>

Overrides PagedSet.delete

has

has(value: MapEntry<K, V>): Promise<boolean>
Inherit Doc
Parameters
- value: MapEntry<K, V>
Returns Promise<boolean>

Overrides PagedSet.has