Class LevelBlockstore

A blockstore backed by leveldb

Hierarchy (View Summary)

BaseBlockstore
- LevelBlockstore

Index

Constructors

constructor

Properties

Methods

close delete deleteMany get getAll getMany has open put putMany

Constructors

constructor

new LevelBlockstore(
path: string | Level<string, Uint8Array<ArrayBufferLike>>,
init?: LevelBlockstoreInit,
): LevelBlockstore
Parameters
- path: string | Level<string, Uint8Array<ArrayBufferLike>>
- init: LevelBlockstoreInit = {}
Returns LevelBlockstore
Overrides BaseBlockstore.constructor
- Defined in packages/blockstore-level/src/index.ts:49

Properties

db

db: Level<string, Uint8Array<ArrayBufferLike>>

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/blockstore-level/src/index.ts:138

delete

delete(key: CID, options?: AbortOptions): Promise<void>
Remove the record for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Overrides BaseBlockstore.delete
- Defined in packages/blockstore-level/src/index.ts:129

deleteMany

deleteMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions,
): AwaitGenerator<CID<unknown, number, number, Version>>
Remove values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions
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 BaseBlockstore.deleteMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:11

get

get(
key: CID,
options?: AbortOptions,
): AwaitGenerator<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Uint8Array<ArrayBufferLike>>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Overrides BaseBlockstore.get
- Defined in packages/blockstore-level/src/index.ts:105

getAll

getAll(options?: AbortOptions): AwaitGenerator<Pair>
Extending classes should override query or implement this method
Parameters
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Pair>
Overrides BaseBlockstore.getAll
- Defined in packages/blockstore-level/src/index.ts:142

getMany

getMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions
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 BaseBlockstore.getMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:9

has

has(key: CID, options?: AbortOptions): Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns 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')
}
```
Overrides BaseBlockstore.has
- Defined in packages/blockstore-level/src/index.ts:122

open

open(): Promise<void>
Returns Promise<void>
- Defined in packages/blockstore-level/src/index.ts:77

put

put(
    key: CID,
    value:
        | Uint8Array<ArrayBufferLike>
        | AwaitIterable<Uint8Array<ArrayBufferLike>>,
    options?: AbortOptions,
): Promise<CID<unknown, number, number, Version>>
Store the passed value under the passed key
Parameters
- key: CID
- value: Uint8Array<ArrayBufferLike> | AwaitIterable<Uint8Array<ArrayBufferLike>>
- Optionaloptions: AbortOptions
Returns Promise<CID<unknown, number, number, Version>>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Overrides BaseBlockstore.put
- Defined in packages/blockstore-level/src/index.ts:85

putMany

putMany(
source: AwaitIterable<InputPair>,
options?: AbortOptions,
): AwaitGenerator<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<InputPair>
- Optionaloptions: AbortOptions
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 BaseBlockstore.putMany
- Defined in packages/blockstore-core/dist/src/base.d.ts:7

Class LevelBlockstore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LevelBlockstore

Properties

db

Methods

close

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Example

deleteMany

Parameters

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

Example

get

Parameters

Returns AwaitGenerator<Uint8Array<ArrayBufferLike>>

Example

getAll

Parameters

Returns AwaitGenerator<Pair>

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Promise<boolean>

Example

open

Returns Promise<void>

put

Parameters

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

Example

putMany

Parameters

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

Example

Settings

On This Page