Interface Blocks

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

Hierarchy

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

Index

Methods

createSession delete deleteMany get getAll getMany has put putMany

Methods

createSession

createSession(
    root: CID,
    options?: CreateSessionOptions<
        GetOfflineOptions & (ProviderOptions & GetBlockProgressEvents),
    >,
): SessionBlockstore
A blockstore session only fetches blocks from a subset of network peers to reduce network traffic and improve performance.

The initial set of peers can be specified, alternatively a findProviders routing query will occur to populate the set instead.
Parameters
- root: CID
- Optionaloptions: CreateSessionOptions<
  GetOfflineOptions & (ProviderOptions & GetBlockProgressEvents),
  >
Returns SessionBlockstore
- Defined in packages/interface/dist/src/blocks.d.ts:46

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:92

deleteMany

deleteMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>,
): AwaitIterable<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions & ProgressOptions<DeleteManyBlocksProgressEvents>
Returns AwaitIterable<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:106

get

get(
    key: CID,
    options?: AbortOptions & GetOfflineOptions & ProviderOptions & ProgressOptions<
        GetBlockProgressEvents,
    >,
): Await<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions & GetOfflineOptions & ProviderOptions & ProgressOptions<
  GetBlockProgressEvents,
  >
Returns Await<Uint8Array<ArrayBufferLike>>
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:69

getAll

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

getMany

getMany(
    source: AwaitIterable<CID<unknown, number, number, Version>>,
    options?: AbortOptions & GetOfflineOptions & ProviderOptions & ProgressOptions<
        GetManyBlocksProgressEvents,
    >,
): AwaitIterable<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions & GetOfflineOptions & ProviderOptions & ProgressOptions<
  GetManyBlocksProgressEvents,
  >
Returns AwaitIterable<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:81

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:35

put

put(
    key: CID,
    val: Uint8Array,
    options?: AbortOptions & ProgressOptions<PutBlockProgressEvents>,
): Await<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val: Uint8Array
- 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:45

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
): AwaitIterable<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>
Returns AwaitIterable<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:58

Interface Blocks

Hierarchy

Index

Methods

Methods

createSession

Parameters

Returns SessionBlockstore

delete

Parameters

Returns Await<void>

Example

deleteMany

Parameters

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

Example

get

Parameters

Returns Await<Uint8Array<ArrayBufferLike>>

Example

getAll

Parameters

Returns AwaitIterable<Pair>

Example

getMany

Parameters

Returns AwaitIterable<Pair>

Example

has

Parameters

Returns Await<boolean>

Example

put

Parameters

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

Example

putMany

Parameters

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

Example

Settings

On This Page