Interface SessionBlockstore

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.

interface SessionBlockstore {
    close(): void;
    delete(
        key: CID,
        options?: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>,
    ): Await<void>;
    deleteMany(
        source: AwaitIterable<CID<unknown, number, number, Version>>,
        options?: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>,
    ): AwaitGenerator<CID<unknown, number, number, Version>>;
    get(
        key: CID,
        options?: AbortOptions & GetOfflineOptions & ProgressOptions<
            GetBlockProgressEvents,
        >,
    ): AwaitGenerator;
    getAll(
        options?: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>,
    ): AwaitGenerator<Pair>;
    getMany(
        source: AwaitIterable<CID<unknown, number, number, Version>>,
        options?: AbortOptions & GetOfflineOptions & ProgressOptions<
            GetManyBlocksProgressEvents,
        >,
    ): AwaitGenerator<Pair>;
    has(
        key: CID,
        options?: AbortOptions & ProgressOptions<HasBlockProgressEvents>,
    ): Await<boolean>;
    put(
        key: CID,
        val:
            | Uint8Array<ArrayBufferLike>
            | AwaitIterable<Uint8Array<ArrayBufferLike>>,
        options?: AbortOptions & ProgressOptions<PutBlockProgressEvents>,
    ): Await<CID<unknown, number, number, Version>>;
    putMany(
        source: AwaitIterable<InputPair>,
        options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
    ): AwaitGenerator<CID<unknown, number, number, Version>>;
}

Hierarchy

Blockstore<
    ProgressOptions<HasBlockProgressEvents>,
    ProgressOptions<PutBlockProgressEvents>,
    ProgressOptions<PutManyBlocksProgressEvents>,
    GetOfflineOptions & ProgressOptions<GetBlockProgressEvents>,
    GetOfflineOptions & ProgressOptions<GetManyBlocksProgressEvents>,
    ProgressOptions<GetAllBlocksProgressEvents>,
    ProgressOptions<DeleteBlockProgressEvents>,
    ProgressOptions<DeleteManyBlocksProgressEvents>,
>
- SessionBlockstore

Index

Methods

close delete deleteMany get getAll getMany has put putMany

Methods

close

close(): void
Any in-progress operations will be aborted.

Returns void
- Defined in packages/interface/dist/src/blocks.d.ts:58

delete

delete(
key: CID,
options?: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>,
): Await<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>
Returns Await<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Inherited from Blockstore.delete
- Defined in node_modules/interface-store/dist/src/index.d.ts:96

deleteMany

deleteMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>,
): AwaitGenerator<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>
Returns AwaitGenerator<CID<unknown, number, number, Version>>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Inherited from Blockstore.deleteMany
- Defined in node_modules/interface-store/dist/src/index.d.ts:110

get

get(
    key: CID,
    options?: AbortOptions & GetOfflineOptions & ProgressOptions<
        GetBlockProgressEvents,
    >,
): AwaitGenerator
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions & GetOfflineOptions & ProgressOptions<GetBlockProgressEvents>
Returns AwaitGenerator
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Inherited from Blockstore.get
- Defined in node_modules/interface-store/dist/src/index.d.ts:73

getAll

getAll(
options?: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>,
): AwaitGenerator<Pair>
Retrieve all cid/block pairs from the blockstore as an unordered iterable
Parameters
- Optionaloptions: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>
Returns AwaitGenerator<Pair>
Example
```
for await (const { multihash, bytes } of store.getAll()) {
  console.log('got:', multihash, bytes)
  // => got MultihashDigest('Qmfoo') [Uint8Array[...]...]
}
```
Inherited from Blockstore.getAll
- Defined in node_modules/interface-blockstore/dist/src/index.d.ts:38

getMany

getMany(
    source: AwaitIterable<CID<unknown, number, number, Version>>,
    options?: AbortOptions & GetOfflineOptions & ProgressOptions<
        GetManyBlocksProgressEvents,
    >,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions & GetOfflineOptions & ProgressOptions<GetManyBlocksProgressEvents>
Returns AwaitGenerator<Pair>
Example
```
for await (const { key, value } of store.getMany([new Key('awesome')])) {
  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
  // => got "/awesome" = "datastore"
}
```
Inherited from Blockstore.getMany
- Defined in node_modules/interface-store/dist/src/index.d.ts:85

has

has(
key: CID,
options?: AbortOptions & ProgressOptions<HasBlockProgressEvents>,
): Await<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & ProgressOptions<HasBlockProgressEvents>
Returns Await<boolean>
Example
```
const exists = await store.has(new Key('awesome'))

if (exists) {
 console.log('it is there')
} else {
 console.log('it is not there')
}
```
Inherited from Blockstore.has
- Defined in node_modules/interface-store/dist/src/index.d.ts:39

put

put(
    key: CID,
    val:
        | Uint8Array<ArrayBufferLike>
        | AwaitIterable<Uint8Array<ArrayBufferLike>>,
    options?: AbortOptions & ProgressOptions<PutBlockProgressEvents>,
): Await<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val: Uint8Array<ArrayBufferLike> | AwaitIterable<Uint8Array<ArrayBufferLike>>
- Optionaloptions: AbortOptions & ProgressOptions<PutBlockProgressEvents>
Returns Await<CID<unknown, number, number, Version>>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Inherited from Blockstore.put
- Defined in node_modules/interface-store/dist/src/index.d.ts:49

putMany

putMany(
source: AwaitIterable<InputPair>,
options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
): AwaitGenerator<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<InputPair>
- Optionaloptions: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>
Returns AwaitGenerator<CID<unknown, number, number, Version>>
Example
```
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}`)
}
```
Inherited from Blockstore.putMany
- Defined in node_modules/interface-store/dist/src/index.d.ts:62

Interface SessionBlockstore

Hierarchy

Index

Methods

Methods

close

Returns void

delete

Parameters

Returns Await<void>

Example

deleteMany

Parameters

Returns AwaitGenerator<CID<unknown, number, number, Version>>

Example

get

Parameters

Returns AwaitGenerator

Example

getAll

Parameters

Returns AwaitGenerator<Pair>

Example

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Await<boolean>

Example

put

Parameters

Returns Await<CID<unknown, number, number, Version>>

Example

putMany

Parameters

Returns AwaitGenerator<CID<unknown, number, number, Version>>

Example

Settings

On This Page