Class BlockstoreMap<T>

A distributed AutoKeyMap based on Blockstore.

Type Parameters

T = Uint8Array

Implements

AutoKeyMap<ContentId, T>
AutoKeyMapBatch<ContentId, T>

Index

Constructors

Properties

codec hasher store

Accessors

Methods

asCID delete deleteMany get getKey getMany has hasMany put putMany

Constructors

constructor

new BlockstoreMap<T>(store, codec, hasher?): BlockstoreMap<T>
Type Parameters
- T = Uint8Array
Parameters
- store: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
  Blockstore instance.
- codec: BlockCodec<number, T>
  Codec to encode data for storage.
- hasher: MultihashHasher<number> = sha256
  Hash function to use for generating ContentIds for block data.
Returns BlockstoreMap<T>
- Defined in plugins/ipfs/src/blockstore.ts:11

Properties

`Protected` `Readonly` codec

codec: BlockCodec<number, T>

Codec to encode data for storage.

`Protected` `Readonly` hasher

hasher: MultihashHasher<number> = sha256

Hash function to use for generating ContentIds for block data.

`Protected` `Readonly` store

store: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

Blockstore instance.

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in plugins/ipfs/src/blockstore.ts:86

Methods

`Protected` asCID

asCID(key): CID<unknown, number, number, Version>
Parameters
- key: ContentId<number, number>
Returns CID<unknown, number, number, Version>
- Defined in plugins/ipfs/src/blockstore.ts:90

delete

delete(key, options?): MaybePromise<void>
Deletes the value with given key.
Parameters
- key: ContentId<number, number>
- Optional options: AbortOptions
Returns MaybePromise<void>
Implementation of AutoKeyMap.delete
- Defined in plugins/ipfs/src/blockstore.ts:48

deleteMany

deleteMany(keys, options?): AsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<ContentId<number, number>>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of AutoKeyMapBatch.deleteMany
- Defined in plugins/ipfs/src/blockstore.ts:64

get

get(key, options?): MaybePromise<undefined | T>
Gets a value by key from the map.
Parameters
- key: ContentId<number, number>
- Optional options: AbortOptions
Returns MaybePromise<undefined | T>
Implementation of AutoKeyMap.get
- Defined in plugins/ipfs/src/blockstore.ts:28

getKey

getKey(value): MaybePromise<CID<unknown, number, number, Version>>
Gets the key of given value.
Parameters
- value: T
Returns MaybePromise<CID<unknown, number, number, Version>>
Implementation of AutoKeyMap.getKey
- Defined in plugins/ipfs/src/blockstore.ts:21

getMany

getMany(keys, options?): AsyncIterableIterator<undefined | T>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<ContentId<number, number>>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | T>
Implementation of AutoKeyMapBatch.getMany
- Defined in plugins/ipfs/src/blockstore.ts:52

has

has(key, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- key: ContentId<number, number>
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Implementation of AutoKeyMap.has
- Defined in plugins/ipfs/src/blockstore.ts:36

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<ContentId<number, number>>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of AutoKeyMapBatch.hasMany
- Defined in plugins/ipfs/src/blockstore.ts:58

put

put(value, options?): MaybePromise<CID<unknown, number, number, Version>>
Puts given value and returns its key.
Parameters
- value: T
- Optional options: AbortOptions
Returns MaybePromise<CID<unknown, number, number, Version>>
Implementation of AutoKeyMap.put
- Defined in plugins/ipfs/src/blockstore.ts:40

putMany

putMany(values, options?): AsyncIterableIterator<[key: CID<unknown, number, number, Version>, error?: Error]>
Puts given list of values and returns their keys.
Parameters
- values: Iterable<T>
- Optional options: AbortOptions
Returns AsyncIterableIterator<[key: CID<unknown, number, number, Version>, error?: Error]>
Implementation of AutoKeyMapBatch.putMany
- Defined in plugins/ipfs/src/blockstore.ts:70

Generated using TypeDoc