Remove the record for the passed key
Optional
options: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
Remove values for the passed keys
Optional
options: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>const source = [new Key('awesome')]
for await (const key of store.deleteMany(source)) {
console.log(`deleted content with key ${key}`)
}
Retrieve the value stored under the given key
Optional
options: AbortOptions & GetOfflineOptions & ProgressOptions<GetBlockProgressEvents>const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
Retrieve all cid/block pairs from the blockstore as an unordered iterable
Optional
options: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>for await (const { multihash, block } of store.getAll()) {
console.log('got:', multihash, block)
// => got MultihashDigest('Qmfoo') Uint8Array[...]
}
Retrieve values for the passed keys
Optional
options: AbortOptions & GetOfflineOptions & ProgressOptions<GetManyBlocksProgressEvents>for await (const { key, value } of store.getMany([new Key('awesome')])) {
console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
// => got "/awesome" = "datastore"
}
Check for the existence of a value for the passed key
Optional
options: AbortOptions & ProgressOptions<HasBlockProgressEvents>const exists = await store.has(new Key('awesome'))
if (exists) {
console.log('it is there')
} else {
console.log('it is not there')
}
Store the passed value under the passed key
Optional
options: AbortOptions & ProgressOptions<PutBlockProgressEvents>await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
Store the given key/value pairs
Optional
options: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]
for await (const { key, value } of store.putMany(source)) {
console.info(`put content for key ${key}`)
}
A session blockstore is a special blockstore that only pulls content from a subset of network peers which respond as having the block for the initial root CID.
Any blocks written to the blockstore as part of the session will propagate to the blockstore the session was created from.