Interface Blocks

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

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<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<GetBlockProgressEvents>
Returns SessionBlockstore
- Defined in packages/interface/src/blocks.ts:127

delete

delete(
key: CID,
options?: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>,
): void | Promise<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & ProgressOptions<DeleteBlockProgressEvents>
Returns void | Promise<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:79

deleteMany

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

get

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

getAll

getAll(
options?: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>,
): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Retrieve all cid/block pairs from the blockstore as an unordered iterable
Parameters
- Optionaloptions: AbortOptions & ProgressOptions<GetAllBlocksProgressEvents>
Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
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:39

getMany

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

has

has(
key: CID,
options?: AbortOptions & ProgressOptions<HasBlockProgressEvents>,
): boolean | Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions & ProgressOptions<HasBlockProgressEvents>
Returns boolean | Promise<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:22

put

put(
    key: CID,
    val:
        | Uint8Array<ArrayBufferLike>
        | Iterable<Uint8Array<ArrayBufferLike>, any, any>
        | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>,
    options?: AbortOptions & ProgressOptions<PutBlockProgressEvents>,
):
    | CID<unknown, number, number, Version>
    | Promise<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val:
      | Uint8Array<ArrayBufferLike>
      | Iterable<Uint8Array<ArrayBufferLike>, any, any>
      | AsyncIterable<Uint8Array<ArrayBufferLike>, any, any>
- Optionaloptions: AbortOptions & ProgressOptions<PutBlockProgressEvents>
Returns
| CID<unknown, number, number, Version>
| Promise<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:32

putMany

putMany(
    source:
        | Iterable<InputPair, any, any>
        | AsyncIterable<InputPair, any, any>,
    options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
):
    | Generator<CID<unknown, number, number, Version>, any, any>
    | AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Store the given key/value pairs
Parameters
- source: Iterable<InputPair, any, any> | AsyncIterable<InputPair, any, any>
- Optionaloptions: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>
Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>
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:45

Interface Blocks

Hierarchy

Index

Methods

Methods

createSession

Parameters

Returns SessionBlockstore

delete

Parameters

Returns void | Promise<void>

Example

deleteMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

get

Parameters

Returns | Generator<Uint8Array<ArrayBufferLike>, any, any> | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

Example

getAll

Parameters

Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

Example

getMany

Parameters

Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

Example

has

Parameters

Returns boolean | Promise<boolean>

Example

put

Parameters

Returns | CID<unknown, number, number, Version> | Promise<CID<unknown, number, number, Version>>

Example

putMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

Settings

On This Page

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Returns
| Generator<Uint8Array<ArrayBufferLike>, any, any>
| AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

Returns
| CID<unknown, number, number, Version>
| Promise<CID<unknown, number, number, Version>>

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>