KeySet Class

A class that holds multiple KeySet.Key objects. It's basically used as a container that holds multiple keys of different types.

Methods

Name Description
constructor(source?: Keys): KeySet Creates an instance of KeySet.  
add(value: Keys | Key, pred?: (key: Key) => boolean): KeySet Add a key or keys to this KeySet.  
clear(): KeySet Clear this KeySet.  
delete(value: Keys | Key): KeySet Deletes a key or keys from this KeySet.  
forEach(callback: (key: Key, index: number) => void): void Iterate over all keys in this keyset.  
forEachBatch(batchSize: number, callback: (batch: KeySet, index: number) => void): void Iterate over all keys in this keyset in batches  
has(value: Key): boolean Check if this KeySet contains the specified key.  
hasAll(keys: Keys): boolean Check if this KeySet contains all the specified keys.  
hasAny(keys: Keys): boolean Check if this KeySet contains any of the specified keys.  

Properties

Name Type Description
guid Accessor ReadOnly GuidString Get a GUID that identifies changes in this keyset.  
instanceKeys Accessor ReadOnly Map<string, Set<InstanceId>> Get a map of instance keys stored in this KeySet

Warning: getting instance keys might be expensive for
large KeySets.
 
instanceKeysCount Accessor ReadOnly number Get instance keys count  
isEmpty Accessor ReadOnly boolean Is this KeySet currently empty.  
nodeKeys Accessor ReadOnly Set<NodeKey> Get a set of node keys stored in this KeySet

Warning: getting node keys might be expensive for
large KeySets.
 
nodeKeysCount Accessor ReadOnly number Get node keys count  
size Accessor ReadOnly number Get the number of keys stored in this KeySet.  

Defined in

Last Updated: 20 September, 2019