Class ConcurrentExpiringMap<TKey>

Package version

Describes a map that ensures, deleting a an entry from the map is concurrency safe.

internal

Type parameters

TKey

Hierarchy

ConcurrentExpiringMap

Index

Constructors

constructor

Methods

Constructors

constructor

new ConcurrentExpiringMap(options?: undefined | { delayBetweenCleanupInMs?: undefined | number }): ConcurrentExpiringMap

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/concurrentExpiringMap.ts:18
Parameters
- Optional options: undefined | { delayBetweenCleanupInMs?: undefined | number }
Returns ConcurrentExpiringMap

Methods

clear

clear(): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/concurrentExpiringMap.ts:101
Clears all the entries from the underlying map.

Returns void

delete

delete(key: TKey): boolean

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/concurrentExpiringMap.ts:93
Removes an entry from the the map if present

Parameters
- key: TKey
  
  The key which needs to be removed from the map.
Returns boolean

True if the key was found and removed from the map, False otherwise

has

has(key: TKey): boolean

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/concurrentExpiringMap.ts:81
Determines whether the key is present in the map.

Parameters
- key: TKey
  
  The key whose presence in the map needs to be checked.
Returns boolean

boolean

set

set(key: TKey, expiration: Date): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/concurrentExpiringMap.ts:65
Sets the key and it's expiration time as the value in the map.

Parameters
- key: TKey
  
  The key to be set.
- expiration: Date
  
  Expiration time for the key.
Returns void

void

Generated using TypeDoc