AsyncMap | @vertx/core

An asynchronous map.

AsyncMap does not allow null to be used as a key or value.

Type parameters

Hierarchy

AsyncMap

Index

Methods

clear

clear(): PromiseLike<void>
clear(resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:486
Clear all entries in the map

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:491
Clear all entries in the map

Parameters
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

get

get(k: K): PromiseLike<V>
get(k: K, resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:370
Get a value from the map, asynchronously.

Parameters
- k: K
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:375
Get a value from the map, asynchronously.

Parameters
- k: K
- resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void

keys

keys(): PromiseLike<K>
keys(resultHandler: ((res: AsyncResult<K>) => void) | Handler<AsyncResult<K>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:510
Get the keys of the map, asynchronously.

Use this method with care as the map may contain a large number of keys, which may not fit entirely in memory of a single node. In this case, the invocation will result in an OutOfMemoryError.

Returns PromiseLike<K>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:519
Get the keys of the map, asynchronously.

Use this method with care as the map may contain a large number of keys, which may not fit entirely in memory of a single node. In this case, the invocation will result in an OutOfMemoryError.

Parameters
- resultHandler: ((res: AsyncResult<K>) => void) | Handler<AsyncResult<K>>
Returns void

put

put(k: K, v: V): PromiseLike<void>
put(k: K, v: V, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
put(k: K, v: V, ttl: number): PromiseLike<void>
put(k: K, v: V, ttl: number, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:380
Put a value in the map, asynchronously.

Parameters
- k: K
- v: V
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:385
Put a value in the map, asynchronously.

Parameters
- k: K
- v: V
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:391
Like {@link AsyncMap#put} but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters
- k: K
- v: V
- ttl: number
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:397
Like {@link AsyncMap#put} but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters
- k: K
- v: V
- ttl: number
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

putIfAbsent

putIfAbsent(k: K, v: V): PromiseLike<V>
putIfAbsent(k: K, v: V, completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void
putIfAbsent(k: K, v: V, ttl: number): PromiseLike<V>
putIfAbsent(k: K, v: V, ttl: number, completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:403
Put the entry only if there is no entry with the key already present. If key already present then the existing value will be returned to the handler, otherwise null.

Parameters
- k: K
- v: V
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:409
Put the entry only if there is no entry with the key already present. If key already present then the existing value will be returned to the handler, otherwise null.

Parameters
- k: K
- v: V
- completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:415
Link {@link AsyncMap#putIfAbsent} but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters
- k: K
- v: V
- ttl: number
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:421
Link {@link AsyncMap#putIfAbsent} but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters
- k: K
- v: V
- ttl: number
- completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void

remove

remove(k: K): PromiseLike<V>
remove(k: K, resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:426
Remove a value from the map, asynchronously.

Parameters
- k: K
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:431
Remove a value from the map, asynchronously.

Parameters
- k: K
- resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void

removeIfPresent

removeIfPresent(k: K, v: V): PromiseLike<boolean>
removeIfPresent(k: K, v: V, resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:436
Remove a value from the map, only if entry already exists with same value.

Parameters
- k: K
- v: V
Returns PromiseLike<boolean>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:441
Remove a value from the map, only if entry already exists with same value.

Parameters
- k: K
- v: V
- resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns void

replace

replace(k: K, v: V): PromiseLike<V>
replace(k: K, v: V, resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void
replace(k: K, v: V, ttl: number): PromiseLike<V>
replace(k: K, v: V, ttl: number, resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:446
Replace the entry only if it is currently mapped to some value

Parameters
- k: K
- v: V
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:451
Replace the entry only if it is currently mapped to some value

Parameters
- k: K
- v: V
- resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:456
Replace the entry only if it is currently mapped to some value

Parameters
- k: K
- v: V
- ttl: number
Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:461
Replace the entry only if it is currently mapped to some value

Parameters
- k: K
- v: V
- ttl: number
- resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void

replaceIfPresent

replaceIfPresent(k: K, oldValue: V, newValue: V): PromiseLike<boolean>
replaceIfPresent(k: K, oldValue: V, newValue: V, resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): void
replaceIfPresent(k: K, oldValue: V, newValue: V, ttl: number): PromiseLike<boolean>
replaceIfPresent(k: K, oldValue: V, newValue: V, ttl: number, resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:466
Replace the entry only if it is currently mapped to a specific value

Parameters
- k: K
- oldValue: V
- newValue: V
Returns PromiseLike<boolean>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:471
Replace the entry only if it is currently mapped to a specific value

Parameters
- k: K
- oldValue: V
- newValue: V
- resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:476
Replace the entry only if it is currently mapped to a specific value

Parameters
- k: K
- oldValue: V
- newValue: V
- ttl: number
Returns PromiseLike<boolean>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:481
Replace the entry only if it is currently mapped to a specific value

Parameters
- k: K
- oldValue: V
- newValue: V
- ttl: number
- resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns void

size

size(): PromiseLike<number>
size(resultHandler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:496
Provide the number of entries in the map

Returns PromiseLike<number>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:501
Provide the number of entries in the map

Parameters
- resultHandler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>
Returns void

values

values(): PromiseLike<V>
values(resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:528
Get the values of the map, asynchronously.

Use this method with care as the map may contain a large number of values, which may not fit entirely in memory of a single node. In this case, the invocation will result in an OutOfMemoryError.

Returns PromiseLike<V>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:537
Get the values of the map, asynchronously.

Use this method with care as the map may contain a large number of values, which may not fit entirely in memory of a single node. In this case, the invocation will result in an OutOfMemoryError.

Parameters
- resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>
Returns void

Type parameters

K

V

Hierarchy

Index

Methods

Methods

clear

Returns PromiseLike<void>

Parameters

resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

get

Parameters

k: K

Returns PromiseLike<V>

Parameters

k: K

resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>

Returns void

keys

Returns PromiseLike<K>

Parameters

resultHandler: ((res: AsyncResult<K>) => void) | Handler<AsyncResult<K>>

Returns void

put

Parameters

k: K

v: V

Returns PromiseLike<void>

Parameters

k: K

v: V

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters

k: K

v: V

ttl: number

Returns PromiseLike<void>

Parameters

k: K

v: V

ttl: number

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

putIfAbsent

Parameters

k: K

v: V

Returns PromiseLike<V>

Parameters

k: K

v: V

completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>

Returns void

Parameters

k: K

v: V

ttl: number

Returns PromiseLike<V>

Parameters

k: K

v: V

ttl: number

completionHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>

Returns void

remove

Parameters

k: K

Returns PromiseLike<V>

Parameters

k: K

resultHandler: ((res: AsyncResult<V>) => void) | Handler<AsyncResult<V>>

Returns void

removeIfPresent

Parameters

k: K

v: V

Returns PromiseLike<boolean>