Class BaseBlockstore

Hierarchy (View Summary)

BaseBlockstore

Implements

Blockstore

Index

Constructors

constructor

Methods

delete deleteMany get getAll getMany has put putMany

Constructors

constructor

new BaseBlockstore(): BaseBlockstore
Returns BaseBlockstore

Methods

delete

delete(key: CID, options?: AbortOptions): Await<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns Await<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Implementation of Blockstore.delete
- Defined in base.ts:34

deleteMany

deleteMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions,
): AwaitIterable<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions
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}`)
}
```
Implementation of Blockstore.deleteMany
- Defined in base.ts:38

get

get(key: CID, options?: AbortOptions): Await<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns Await<Uint8Array<ArrayBufferLike>>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Implementation of Blockstore.get
- Defined in base.ts:21

getAll

getAll(options?: AbortOptions): AwaitIterable<Pair>
Extending classes should override query or implement this method
Parameters
- Optionaloptions: AbortOptions
Returns AwaitIterable<Pair>
Implementation of Blockstore.getAll
- Defined in base.ts:48

getMany

getMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions,
): AwaitIterable<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions
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"
}
```
Implementation of Blockstore.getMany
- Defined in base.ts:25

has

has(key: CID, options?: AbortOptions): Await<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions
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')
}
```
Implementation of Blockstore.has
- Defined in base.ts:6

put

put(
    key: CID,
    val: Uint8Array,
    options?: AbortOptions,
): Await<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- val: Uint8Array
- Optionaloptions: AbortOptions
Returns Await<CID<unknown, number, number, Version>>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Implementation of Blockstore.put
- Defined in base.ts:10

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions,
): AwaitIterable<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions
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}`)
}
```
Implementation of Blockstore.putMany
- Defined in base.ts:14

Class BaseBlockstore

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Returns BaseBlockstore

Methods

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>

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