Interface AutoKeyMapBatch<K, V>

Batch APIs for a AutoKeyMap.

interface AutoKeyMapBatch {
    deleteMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>;
    getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>;
    hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>;
    putMany(values, options?): MaybeAsyncIterableIterator<[key: K, error?: Error]>;
}

Type Parameters

K = ContentId
V = Uint8Array

Hierarchy

MaybeAsyncReadonlyMapBatch<K, V>
MaybeAsyncSetDeleteBatch<K>
AutoKeyMapPutBatch<K, V>
- AutoKeyMapBatch

Implemented by

ContentAddressedMapStore

Index

Methods

deleteMany getMany hasMany putMany

Methods

deleteMany

deleteMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Inherited from MaybeAsyncSetDeleteBatch.deleteMany
- Defined in collections/src/set.ts:30

getMany

getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | V>
Inherited from MaybeAsyncReadonlyMapBatch.getMany
- Defined in collections/src/map.ts:47

hasMany

hasMany(keys, options?): MaybeAsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<boolean>
Inherited from MaybeAsyncReadonlyMapBatch.hasMany
- Defined in collections/src/set.ts:24

putMany

putMany(values, options?): MaybeAsyncIterableIterator<[key: K, error?: Error]>
Puts given list of values and returns their keys.
Parameters
- values: Iterable<V>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<[key: K, error?: Error]>
Inherited from AutoKeyMapPutBatch.putMany
- Defined in collections/src/map.ts:72

Generated using TypeDoc