From 19b69ce6f36d0289b5c64860eabe1c3151210be7 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Sat, 30 Dec 2023 14:11:16 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- .../blockstore_core.base.BaseBlockstore.html | 18 ++++---- ...e_core.black_hole.BlackHoleBlockstore.html | 18 ++++---- ...ockstore_core.memory.MemoryBlockstore.html | 20 ++++---- ...ockstore_core.tiered.TieredBlockstore.html | 20 ++++---- classes/blockstore_fs.index.FsBlockstore.html | 20 ++++---- .../blockstore_fs.sharding.FlatDirectory.html | 4 +- .../blockstore_fs.sharding.NextToLast.html | 4 +- classes/blockstore_idb.IDBBlockstore.html | 16 +++---- classes/blockstore_level.LevelBlockstore.html | 14 +++--- classes/blockstore_s3.S3Blockstore.html | 16 +++---- .../datastore_core.base.BaseDatastore.html | 26 +++++------ ...re_core.black_hole.BlackHoleDatastore.html | 26 +++++------ ...re.keytransform.KeyTransformDatastore.html | 28 +++++------ ...datastore_core.memory.MemoryDatastore.html | 28 +++++------ .../datastore_core.mount.MountDatastore.html | 30 ++++++------ ...ore_core.namespace.NamespaceDatastore.html | 28 +++++------ classes/datastore_core.shard.NextToLast.html | 4 +- classes/datastore_core.shard.Prefix.html | 4 +- classes/datastore_core.shard.ShardBase.html | 4 +- classes/datastore_core.shard.Suffix.html | 4 +- ...store_core.sharding.ShardingDatastore.html | 28 +++++------ ...datastore_core.tiered.TieredDatastore.html | 28 +++++------ classes/datastore_fs.FsDatastore.html | 28 +++++------ classes/datastore_idb.IDBDatastore.html | 20 ++++---- classes/datastore_level.LevelDatastore.html | 20 ++++---- classes/datastore_s3.S3Datastore.html | 22 ++++----- classes/interface_datastore.key.Key.html | 46 +++++++++---------- .../blockstore_core.errors.abortedError.html | 2 +- ...ockstore_core.errors.closeFailedError.html | 2 +- ...ckstore_core.errors.deleteFailedError.html | 2 +- ...blockstore_core.errors.getFailedError.html | 2 +- ...blockstore_core.errors.hasFailedError.html | 2 +- .../blockstore_core.errors.notFoundError.html | 2 +- ...lockstore_core.errors.openFailedError.html | 2 +- ...blockstore_core.errors.putFailedError.html | 2 +- .../datastore_core.errors.abortedError.html | 2 +- ...store_core.errors.dbDeleteFailedError.html | 2 +- ...tastore_core.errors.dbOpenFailedError.html | 2 +- ...tastore_core.errors.dbReadFailedError.html | 2 +- ...astore_core.errors.dbWriteFailedError.html | 2 +- .../datastore_core.errors.notFoundError.html | 2 +- .../datastore_core.shard.parseShardFun.html | 2 +- .../datastore_core.shard.readShardFun.html | 2 +- ...kstore_tests.interfaceBlockstoreTests.html | 2 +- ...tastore_tests.interfaceDatastoreTests.html | 2 +- .../blockstore_fs.index.FsBlockstoreInit.html | 16 +++---- ...ckstore_fs.sharding.FlatDirectoryInit.html | 8 ++-- ...blockstore_fs.sharding.NextToLastInit.html | 8 ++-- ...ockstore_fs.sharding.ShardingStrategy.html | 4 +- .../blockstore_idb.IDBBlockstoreInit.html | 8 ++-- .../blockstore_level.LevelBlockstoreInit.html | 4 +- .../blockstore_s3.S3BlockstoreInit.html | 6 +-- .../blockstore_s3.ShardingStrategy.html | 4 +- .../datastore_core.index.KeyTransform.html | 4 +- interfaces/datastore_core.index.Shard-1.html | 4 +- interfaces/datastore_fs.FsDatastoreInit.html | 4 +- .../datastore_idb.IDBDatastoreInit.html | 6 +-- interfaces/datastore_s3.S3DatastoreInit.html | 6 +-- .../interface_blockstore.Blockstore.html | 4 +- interfaces/interface_blockstore.Pair.html | 4 +- ...ckstore_tests.InterfaceBlockstoreTest.html | 4 +- .../interface_datastore.index.Batch.html | 4 +- .../interface_datastore.index.Datastore.html | 8 ++-- .../interface_datastore.index.KeyQuery.html | 4 +- ...erface_datastore.index.KeyQueryFilter.html | 2 +- ...terface_datastore.index.KeyQueryOrder.html | 2 +- .../interface_datastore.index.Pair.html | 4 +- .../interface_datastore.index.Query.html | 4 +- ...interface_datastore.index.QueryFilter.html | 2 +- .../interface_datastore.index.QueryOrder.html | 2 +- ...datastore_tests.InterfacDatastoreTest.html | 4 +- interfaces/interface_store.AbortOptions.html | 4 +- interfaces/interface_store.Store.html | 16 +++---- modules/blockstore_core.base.html | 2 +- modules/blockstore_core.black_hole.html | 2 +- modules/blockstore_core.errors.html | 2 +- modules/blockstore_core.html | 4 +- modules/blockstore_core.index.html | 2 +- modules/blockstore_core.memory.html | 2 +- modules/blockstore_core.tiered.html | 2 +- modules/blockstore_fs.html | 4 +- modules/blockstore_fs.index.html | 2 +- modules/blockstore_fs.sharding.html | 2 +- modules/blockstore_idb.html | 4 +- modules/blockstore_level.html | 4 +- modules/blockstore_s3.html | 4 +- modules/datastore_core.base.html | 2 +- modules/datastore_core.black_hole.html | 2 +- modules/datastore_core.errors.html | 2 +- modules/datastore_core.html | 4 +- modules/datastore_core.index.html | 2 +- modules/datastore_core.keytransform.html | 2 +- modules/datastore_core.memory.html | 2 +- modules/datastore_core.mount.html | 2 +- modules/datastore_core.namespace.html | 2 +- modules/datastore_core.shard.html | 2 +- modules/datastore_core.sharding.html | 2 +- modules/datastore_core.tiered.html | 2 +- modules/datastore_fs.html | 4 +- modules/datastore_idb.html | 4 +- modules/datastore_level.html | 4 +- modules/datastore_s3.html | 4 +- modules/interface_blockstore.html | 4 +- modules/interface_blockstore_tests.html | 4 +- modules/interface_datastore.html | 4 +- modules/interface_datastore.index.html | 2 +- modules/interface_datastore.key.html | 2 +- modules/interface_datastore_tests.html | 4 +- modules/interface_store.html | 4 +- types/interface_store.Await.html | 2 +- types/interface_store.AwaitIterable.html | 2 +- variables/blockstore_core.index.Errors.html | 2 +- variables/datastore_core.shard.PREFIX-1.html | 2 +- .../datastore_core.shard.SHARDING_FN.html | 2 +- 114 files changed, 411 insertions(+), 411 deletions(-) diff --git a/classes/blockstore_core.base.BaseBlockstore.html b/classes/blockstore_core.base.BaseBlockstore.html index 77fd20be..30cd7b10 100644 --- a/classes/blockstore_core.base.BaseBlockstore.html +++ b/classes/blockstore_core.base.BaseBlockstore.html @@ -1,4 +1,4 @@ -BaseBlockstore | IPFS Stores

Class BaseBlockstore

Hierarchy

Implements

Constructors

constructor +BaseBlockstore | IPFS Stores

Class BaseBlockstore

Hierarchy

Implements

Constructors

constructor

Methods

delete deleteMany get @@ -10,23 +10,23 @@

Constructors

constructor

Methods

delete

  • delete(key, options?): Promise<void>

  • Remove the record for the passed key

    Parameters

    Returns Promise<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -

deleteMany

deleteMany

get

get

  • get(key, options?): Await<Uint8Array>

  • Retrieve the value stored under the given key

    Parameters

    Returns Await<Uint8Array>

    Example

    const value = await store.get(new Key('awesome'))
    console.log('got content: %s', value.toString('utf8'))
    // => got content: datastore
    -

getAll

getMany

getAll

getMany

has

has

  • has(key, options?): Await<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

put

put

putMany

putMany

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_core.black_hole.BlackHoleBlockstore.html b/classes/blockstore_core.black_hole.BlackHoleBlockstore.html index 1d66bf2e..0dd35085 100644 --- a/classes/blockstore_core.black_hole.BlackHoleBlockstore.html +++ b/classes/blockstore_core.black_hole.BlackHoleBlockstore.html @@ -1,4 +1,4 @@ -BlackHoleBlockstore | IPFS Stores

Class BlackHoleBlockstore

Hierarchy

Constructors

constructor +BlackHoleBlockstore | IPFS Stores

Class BlackHoleBlockstore

Hierarchy

Constructors

constructor

Methods

delete deleteMany get @@ -10,23 +10,23 @@

Constructors

constructor

Methods

delete

deleteMany

deleteMany

get

get

getAll

getMany

getAll

getMany

has

has

  • has(): Await<boolean>

  • Check for the existence of a value for the passed key

    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')
    }
    -

put

put

putMany

putMany

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_core.memory.MemoryBlockstore.html b/classes/blockstore_core.memory.MemoryBlockstore.html index 9f30c787..e97e95a6 100644 --- a/classes/blockstore_core.memory.MemoryBlockstore.html +++ b/classes/blockstore_core.memory.MemoryBlockstore.html @@ -1,4 +1,4 @@ -MemoryBlockstore | IPFS Stores

Class MemoryBlockstore

Hierarchy

Constructors

constructor +MemoryBlockstore | IPFS Stores

Class MemoryBlockstore

Hierarchy

Constructors

constructor

Properties

data

Methods

delete deleteMany @@ -8,26 +8,26 @@ has put putMany -

Constructors

constructor

Properties

Private Readonly data

data: Map<string, Uint8Array>

Methods

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    +

Constructors

constructor

Properties

Private Readonly data

data: Map<string, Uint8Array>

Methods

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    Parameters

    Returns Promise<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -

deleteMany

deleteMany

get

get

  • get(key): Await<Uint8Array>

  • Retrieve the value stored under the given key

    Parameters

    Returns Await<Uint8Array>

    Example

    const value = await store.get(new Key('awesome'))
    console.log('got content: %s', value.toString('utf8'))
    // => got content: datastore
    -

getAll

getMany

getAll

getMany

has

has

  • has(key): Await<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

put

put

putMany

putMany

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_core.tiered.TieredBlockstore.html b/classes/blockstore_core.tiered.TieredBlockstore.html index e7fec293..e4e48b3f 100644 --- a/classes/blockstore_core.tiered.TieredBlockstore.html +++ b/classes/blockstore_core.tiered.TieredBlockstore.html @@ -2,7 +2,7 @@ will write through to all blockstores. Has and get will try each store sequentially. getAll will use every store but also deduplicate any yielded pairs.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

stores

Methods

delete deleteMany @@ -12,26 +12,26 @@ has put putMany -

Constructors

constructor

Properties

Private Readonly stores

stores: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>[]

Methods

delete

  • delete(key, options?): Promise<void>

  • Remove the record for the passed key

    +

Constructors

constructor

Properties

Private Readonly stores

stores: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>[]

Methods

delete

deleteMany

deleteMany

  • deleteMany(source, options?): AsyncIterable<CID<unknown, number, number, Version>>

  • Remove values for the passed keys

    Parameters

    Returns AsyncIterable<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}`)
    }
    -

get

get

getAll

getMany

getAll

getMany

has

has

  • has(key, options?): Promise<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

put

put

putMany

putMany

  • putMany(source, options?): AsyncIterable<CID<unknown, number, number, Version>>

  • Store the given key/value pairs

    Parameters

    Returns AsyncIterable<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}`)
    }
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_fs.index.FsBlockstore.html b/classes/blockstore_fs.index.FsBlockstore.html index f7e16fb1..1bb35f3d 100644 --- a/classes/blockstore_fs.index.FsBlockstore.html +++ b/classes/blockstore_fs.index.FsBlockstore.html @@ -1,5 +1,5 @@ FsBlockstore | IPFS Stores

Class FsBlockstore

A blockstore backed by the file system

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

createIfMissing deleteManyConcurrency errorIfExists @@ -17,26 +17,26 @@ open put putMany -

Constructors

constructor

Properties

Private Readonly createIfMissing

createIfMissing: boolean

Private Readonly deleteManyConcurrency

deleteManyConcurrency: number

Private Readonly errorIfExists

errorIfExists: boolean

Private Readonly getManyConcurrency

getManyConcurrency: number

path

path: string

Private Readonly putManyConcurrency

putManyConcurrency: number

Private Readonly shardingStrategy

shardingStrategy: ShardingStrategy

Methods

close

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    +

Constructors

constructor

Properties

Private Readonly createIfMissing

createIfMissing: boolean

Private Readonly deleteManyConcurrency

deleteManyConcurrency: number

Private Readonly errorIfExists

errorIfExists: boolean

Private Readonly getManyConcurrency

getManyConcurrency: number

path

path: string

Private Readonly putManyConcurrency

putManyConcurrency: number

Private Readonly shardingStrategy

shardingStrategy: ShardingStrategy

Methods

close

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    Parameters

    Returns Promise<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -

deleteMany

deleteMany

  • deleteMany(source): AsyncIterable<CID<unknown, number, number, Version>>

  • Remove values for the passed keys

    Parameters

    Returns AsyncIterable<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}`)
    }
    -

get

get

  • get(key): Promise<Uint8Array>

  • Retrieve the value stored under the given key

    Parameters

    Returns Promise<Uint8Array>

    Example

    const value = await store.get(new Key('awesome'))
    console.log('got content: %s', value.toString('utf8'))
    // => got content: datastore
    -

getAll

  • getAll(): AsyncIterable<Pair>

  • Retrieve all cid/block pairs from the blockstore as an unordered iterable

    +

getAll

  • getAll(): AsyncIterable<Pair>

  • Retrieve all cid/block pairs from the blockstore as an unordered iterable

    Returns AsyncIterable<Pair>

    Example

    for await (const { multihash, block } of store.getAll()) {
      console.log('got:', multihash, block)
      // => got MultihashDigest('Qmfoo') Uint8Array[...]
    }
    -

getMany

getMany

  • getMany(source): AsyncIterable<Pair>

  • Retrieve values for the passed keys

    Parameters

    Returns AsyncIterable<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"
    }
    -

has

open

put

has

open

put

putMany

putMany

  • putMany(source): AsyncIterable<CID<unknown, number, number, Version>>

  • Store the given key/value pairs

    Parameters

    Returns AsyncIterable<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}`)
    }
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_fs.sharding.FlatDirectory.html b/classes/blockstore_fs.sharding.FlatDirectory.html index 6840f127..f8c235c7 100644 --- a/classes/blockstore_fs.sharding.FlatDirectory.html +++ b/classes/blockstore_fs.sharding.FlatDirectory.html @@ -1,8 +1,8 @@ FlatDirectory | IPFS Stores

Class FlatDirectory

A sharding strategy that does not do any sharding and stores all files in one directory. Only for testing, do not use in production.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

base extension

Methods

decode encode -

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

extension

extension: string

Methods

decode

encode

  • encode(cid): {
        dir: string;
        file: string;
    }

  • Parameters

    Returns {
        dir: string;
        file: string;
    }

    • dir: string
    • file: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

extension

extension: string

Methods

decode

encode

  • encode(cid): {
        dir: string;
        file: string;
    }

  • Parameters

    Returns {
        dir: string;
        file: string;
    }

    • dir: string
    • file: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_fs.sharding.NextToLast.html b/classes/blockstore_fs.sharding.NextToLast.html index 25f1ba5f..189b8738 100644 --- a/classes/blockstore_fs.sharding.NextToLast.html +++ b/classes/blockstore_fs.sharding.NextToLast.html @@ -2,10 +2,10 @@ CID and uses them as the directory to store the block in. This prevents storing all blocks in a single directory which would overwhelm most filesystems.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

base extension prefixLength

Methods

decode encode -

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

extension

extension: string

Private Readonly prefixLength

prefixLength: number

Methods

decode

encode

  • encode(cid): {
        dir: string;
        file: string;
    }

  • Parameters

    Returns {
        dir: string;
        file: string;
    }

    • dir: string
    • file: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

extension

extension: string

Private Readonly prefixLength

prefixLength: number

Methods

decode

encode

  • encode(cid): {
        dir: string;
        file: string;
    }

  • Parameters

    Returns {
        dir: string;
        file: string;
    }

    • dir: string
    • file: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_idb.IDBBlockstore.html b/classes/blockstore_idb.IDBBlockstore.html index ea9c3449..e704ca54 100644 --- a/classes/blockstore_idb.IDBBlockstore.html +++ b/classes/blockstore_idb.IDBBlockstore.html @@ -1,4 +1,4 @@ -IDBBlockstore | IPFS Stores

Class IDBBlockstore

Hierarchy

Constructors

constructor +IDBBlockstore | IPFS Stores

Class IDBBlockstore

Hierarchy

Constructors

constructor

Properties

base db? location @@ -16,26 +16,26 @@ open put putMany -

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

Private Optional db

db?: IDBPDatabase<unknown>

Private Readonly location

location: string

Private Readonly version

version: number

Methods

Private #decode

Private #encode

close

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    +

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

Private Optional db

db?: IDBPDatabase<unknown>

Private Readonly location

location: string

Private Readonly version

version: number

Methods

Private #decode

Private #encode

close

delete

deleteMany

deleteMany

destroy

get

destroy

get

getAll

getMany

getAll

getMany

  • getMany(source, options?): AwaitIterable<Pair>

  • Retrieve values for the passed keys

    Parameters

    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"
    }

has

  • has(key): Promise<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

open

put

open

put

putMany

putMany

  • putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>

  • Store the given key/value pairs

    Parameters

    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}`)
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_level.LevelBlockstore.html b/classes/blockstore_level.LevelBlockstore.html index 4cce0229..b6a8a7cc 100644 --- a/classes/blockstore_level.LevelBlockstore.html +++ b/classes/blockstore_level.LevelBlockstore.html @@ -1,5 +1,5 @@ LevelBlockstore | IPFS Stores

Class LevelBlockstore

A blockstore backed by leveldb

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

base db opts @@ -16,26 +16,26 @@ open put putMany -

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

db

db: Level<string, Uint8Array>

Private Readonly opts

opts: OpenOptions

Methods

Private #decode

Private #encode

Private #query

  • #query(opts): AsyncIterable<{
        key: string;
        value: Uint8Array;
    }>

  • Parameters

    • opts: {
          prefix?: string;
          values: boolean;
      }
      • Optional prefix?: string
      • values: boolean

    Returns AsyncIterable<{
        key: string;
        value: Uint8Array;
    }>

close

delete

  • delete(key): Promise<void>

  • Remove the record for the passed key

    +

Constructors

constructor

Properties

Private Readonly base

base: MultibaseCodec<string>

db

db: Level<string, Uint8Array>

Private Readonly opts

opts: OpenOptions

Methods

Private #decode

Private #encode

Private #query

  • #query(opts): AsyncIterable<{
        key: string;
        value: Uint8Array;
    }>

  • Parameters

    • opts: {
          prefix?: string;
          values: boolean;
      }
      • Optional prefix?: string
      • values: boolean

    Returns AsyncIterable<{
        key: string;
        value: Uint8Array;
    }>

close

delete

deleteMany

deleteMany

get

getAll

getMany

getAll

getMany

  • getMany(source, options?): AwaitIterable<Pair>

  • Retrieve values for the passed keys

    Parameters

    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"
    }

has

open

put

open

put

putMany

putMany

  • putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>

  • Store the given key/value pairs

    Parameters

    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}`)
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/blockstore_s3.S3Blockstore.html b/classes/blockstore_s3.S3Blockstore.html index 7af049f0..20a2d112 100644 --- a/classes/blockstore_s3.S3Blockstore.html +++ b/classes/blockstore_s3.S3Blockstore.html @@ -1,5 +1,5 @@ S3Blockstore | IPFS Stores

Class S3Blockstore

A blockstore backed by AWS S3

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

bucket createIfMissing s3 @@ -13,19 +13,19 @@ open put putMany -

Constructors

constructor

Properties

Private Readonly bucket

bucket: string

createIfMissing

createIfMissing: boolean

Private Readonly s3

s3: S3

Private Readonly shardingStrategy

shardingStrategy: ShardingStrategy

Methods

delete

deleteMany

  • deleteMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>

  • Remove values for the passed keys

    +

Constructors

constructor

Properties

Private Readonly bucket

bucket: string

createIfMissing

createIfMissing: boolean

Private Readonly s3

s3: S3

Private Readonly shardingStrategy

shardingStrategy: ShardingStrategy

Methods

delete

deleteMany

get

getAll

getMany

getAll

getMany

  • getMany(source, options?): AwaitIterable<Pair>

  • Retrieve values for the passed keys

    Parameters

    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"
    }

has

open

put

putMany

open

put

putMany

  • putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>

  • Store the given key/value pairs

    Parameters

    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}`)
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/datastore_core.base.BaseDatastore.html b/classes/datastore_core.base.BaseDatastore.html index 91127e18..de494fca 100644 --- a/classes/datastore_core.base.BaseDatastore.html +++ b/classes/datastore_core.base.BaseDatastore.html @@ -1,4 +1,4 @@ -BaseDatastore | IPFS Stores

Class BaseDatastore

Hierarchy

Implements

Constructors

constructor +BaseDatastore | IPFS Stores

Class BaseDatastore

Hierarchy

Implements

Constructors

constructor

Methods

_all _allKeys batch @@ -12,35 +12,35 @@ query queryKeys

Constructors

constructor

Methods

_all

_allKeys

batch

  • batch(): Batch<{}>

  • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

    +

    Parameters

    Returns AwaitIterable<Pair>

_allKeys

batch

  • batch(): Batch<{}>

  • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

    Returns Batch<{}>

    Example

    const b = store.batch()

    for (let i = 0; i < 100; i++) {
      b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
    }

    await b.commit()
    console.log('put 100 values')
    -

delete

delete

  • delete(key, options?): Await<void>

  • Remove the record for the passed key

    Parameters

    Returns Await<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -

deleteMany

deleteMany

get

get

  • get(key, options?): Await<Uint8Array>

  • Retrieve the value stored under the given key

    Parameters

    Returns Await<Uint8Array>

    Example

    const value = await store.get(new Key('awesome'))
    console.log('got content: %s', value.toString('utf8'))
    // => got content: datastore
    -

getMany

getMany

has

has

  • has(key, options?): Await<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

put

put

putMany

putMany

query

query

queryKeys

queryKeys

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/datastore_core.black_hole.BlackHoleDatastore.html b/classes/datastore_core.black_hole.BlackHoleDatastore.html index 050dd33a..2e5bd750 100644 --- a/classes/datastore_core.black_hole.BlackHoleDatastore.html +++ b/classes/datastore_core.black_hole.BlackHoleDatastore.html @@ -1,4 +1,4 @@ -BlackHoleDatastore | IPFS Stores

Class BlackHoleDatastore

Hierarchy

Constructors

constructor +BlackHoleDatastore | IPFS Stores

Class BlackHoleDatastore

Hierarchy

Constructors

constructor

Methods

_all _allKeys batch @@ -12,35 +12,35 @@ query queryKeys

Constructors

constructor

Methods

_all

_allKeys

batch

_allKeys

batch

  • batch(): Batch<{}>

  • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

    Returns Batch<{}>

    Example

    const b = store.batch()

    for (let i = 0; i < 100; i++) {
      b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
    }

    await b.commit()
    console.log('put 100 values')
    -

delete

delete

  • delete(key): Await<void>

  • Remove the record for the passed key

    Parameters

    Returns Await<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -

deleteMany

deleteMany

get

get

getMany

getMany

has

has

  • has(key): Await<boolean>

  • Check for the existence of a value for the passed key

    Parameters

    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')
    }
    -

put

put

  • put(key): Await<Key>

  • Store the passed value under the passed key

    Parameters

    Returns Await<Key>

    Example

    await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
    -

putMany

putMany

query

query

queryKeys

queryKeys

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/datastore_core.keytransform.KeyTransformDatastore.html b/classes/datastore_core.keytransform.KeyTransformDatastore.html index 8082cd46..cb6a101e 100644 --- a/classes/datastore_core.keytransform.KeyTransformDatastore.html +++ b/classes/datastore_core.keytransform.KeyTransformDatastore.html @@ -1,7 +1,7 @@ KeyTransformDatastore | IPFS Stores

Class KeyTransformDatastore

A datastore shim, that wraps around a given datastore, changing the way keys look to the user, for example namespacing keys, reversing them, etc.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

child transform

Methods

_all @@ -16,36 +16,36 @@ putMany query queryKeys -

Constructors

constructor

Properties

Private Readonly child

child: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      transform

                      transform: KeyTransform

                      Methods

                      _all

                      _allKeys

                      batch

                      • batch(): Batch<{}>

                      • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                        +

                      Constructors

                      constructor

                      Properties

                      Private Readonly child

                      child: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          transform

                                          transform: KeyTransform

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          deleteMany

                                          deleteMany

                                          • deleteMany(source, options?): AsyncIterable<Key>

                                          • Remove values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            const source = [new Key('awesome')]

                                            for await (const key of store.deleteMany(source)) {
                                              console.log(`deleted content with key ${key}`)
                                            }
                                            -

                                          get

                                          get

                                          getMany

                                          getMany

                                          • getMany(source, options?): AsyncIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<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"
                                            }
                                            -

                                          has

                                          has

                                          • has(key, options?): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          put

                                          put

                                          putMany

                                          putMany

                                          • putMany(source, options?): AsyncIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            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}`)
                                            }
                                            -

                                          query

                                          query

                                          • query(q, options?): AsyncIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)
                                            -

                                          queryKeys

                                          queryKeys

                                          • queryKeys(q, options?): AsyncIterable<Key>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            // retrieve __all__ keys from the store
                                            let list = []
                                            for await (const key of store.queryKeys({})) {
                                              list.push(key)
                                            }
                                            console.log('ALL THE KEYS', key)
                                            -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.memory.MemoryDatastore.html b/classes/datastore_core.memory.MemoryDatastore.html index e6a59be8..69a34aad 100644 --- a/classes/datastore_core.memory.MemoryDatastore.html +++ b/classes/datastore_core.memory.MemoryDatastore.html @@ -1,4 +1,4 @@ -MemoryDatastore | IPFS Stores

                                          Class MemoryDatastore

                                          Hierarchy

                                          Constructors

                                          constructor +MemoryDatastore | IPFS Stores

                                          Class MemoryDatastore

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          data

                                          Methods

                                          _all _allKeys @@ -12,36 +12,36 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly data

                                          data: Map<string, Uint8Array>

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly data

                                          data: Map<string, Uint8Array>

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          • delete(key): Await<void>

                                          • Remove the record for the passed key

                                            Parameters

                                            Returns Await<void>

                                            Example

                                            await store.delete(new Key('awesome'))
                                            console.log('deleted awesome content :(')
                                            -

                                          deleteMany

                                          deleteMany

                                          get

                                          get

                                          • get(key): Await<Uint8Array>

                                          • Retrieve the value stored under the given key

                                            Parameters

                                            Returns Await<Uint8Array>

                                            Example

                                            const value = await store.get(new Key('awesome'))
                                            console.log('got content: %s', value.toString('utf8'))
                                            // => got content: datastore
                                            -

                                          getMany

                                          getMany

                                          has

                                          has

                                          • has(key): Await<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          put

                                          put

                                          putMany

                                          putMany

                                          query

                                          query

                                          queryKeys

                                          queryKeys

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.mount.MountDatastore.html b/classes/datastore_core.mount.MountDatastore.html index 676f18e1..5de5d209 100644 --- a/classes/datastore_core.mount.MountDatastore.html +++ b/classes/datastore_core.mount.MountDatastore.html @@ -1,6 +1,6 @@ MountDatastore | IPFS Stores

                                          Class MountDatastore

                                          A datastore that can combine multiple stores inside various key prefixes

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          mounts

                                          Methods

                                          _all _allKeys @@ -15,37 +15,37 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly mounts

                                          mounts: {
                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                              prefix: Key;
                                          }[]

                                          Type declaration

                                          • datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>
                                          • prefix: Key

                                          Methods

                                          _all

                                          _allKeys

                                          Private _lookup

                                          • _lookup(key): undefined | {
                                                datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                mountpoint: Key;
                                            }

                                          • Lookup the matching datastore for the given key

                                            -

                                            Parameters

                                            Returns undefined | {
                                                datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                mountpoint: Key;
                                            }

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly mounts

                                          mounts: {
                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                              prefix: Key;
                                          }[]

                                          Type declaration

                                          • datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>
                                          • prefix: Key

                                          Methods

                                          _all

                                          _allKeys

                                          Private _lookup

                                          • _lookup(key): undefined | {
                                                datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                mountpoint: Key;
                                            }

                                          • Lookup the matching datastore for the given key

                                            +

                                            Parameters

                                            Returns undefined | {
                                                datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                mountpoint: Key;
                                            }

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          deleteMany

                                          deleteMany

                                          get

                                          get

                                          getMany

                                          getMany

                                          has

                                          has

                                          • has(key, options?): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          put

                                          put

                                          putMany

                                          putMany

                                          query

                                          query

                                          • query(q, options?): AsyncIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)
                                            -

                                          queryKeys

                                          queryKeys

                                          • queryKeys(q, options?): AsyncIterable<Key>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            // retrieve __all__ keys from the store
                                            let list = []
                                            for await (const key of store.queryKeys({})) {
                                              list.push(key)
                                            }
                                            console.log('ALL THE KEYS', key)
                                            -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.namespace.NamespaceDatastore.html b/classes/datastore_core.namespace.NamespaceDatastore.html index bd5ccbc1..7bbdcedc 100644 --- a/classes/datastore_core.namespace.NamespaceDatastore.html +++ b/classes/datastore_core.namespace.NamespaceDatastore.html @@ -3,7 +3,7 @@

                                          For example, if the prefix is new Key(/hello) a call to store.put(new Key('/world'), mydata) would store the data under /hello/world.

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          transform

                                          Methods

                                          _all _allKeys @@ -17,36 +17,36 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          transform

                                          transform: KeyTransform

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          transform

                                          transform: KeyTransform

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          deleteMany

                                          deleteMany

                                          get

                                          get

                                          getMany

                                          getMany

                                          • getMany(source, options?): AsyncIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<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"
                                            }
                                            -

                                          has

                                          has

                                          • has(key, options?): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          put

                                          put

                                          putMany

                                          putMany

                                          • putMany(source, options?): AsyncIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            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}`)
                                            }
                                            -

                                          query

                                          query

                                          • query(q, options?): AsyncIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)
                                            -

                                          queryKeys

                                          queryKeys

                                          • queryKeys(q, options?): AsyncIterable<Key>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            // retrieve __all__ keys from the store
                                            let list = []
                                            for await (const key of store.queryKeys({})) {
                                              list.push(key)
                                            }
                                            console.log('ALL THE KEYS', key)
                                            -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.shard.NextToLast.html b/classes/datastore_core.shard.NextToLast.html index f2228418..ec276d3c 100644 --- a/classes/datastore_core.shard.NextToLast.html +++ b/classes/datastore_core.shard.NextToLast.html @@ -1,7 +1,7 @@ -NextToLast | IPFS Stores

                                          Class NextToLast

                                          Hierarchy

                                          Constructors

                                          constructor +NextToLast | IPFS Stores

                                          Class NextToLast

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          _padding name param

                                          Methods

                                          fun toString -

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.shard.Prefix.html b/classes/datastore_core.shard.Prefix.html index 16b54589..3b0d02f4 100644 --- a/classes/datastore_core.shard.Prefix.html +++ b/classes/datastore_core.shard.Prefix.html @@ -1,7 +1,7 @@ -Prefix | IPFS Stores

                                          Class Prefix

                                          Hierarchy

                                          Constructors

                                          constructor +Prefix | IPFS Stores

                                          Class Prefix

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          _padding name param

                                          Methods

                                          fun toString -

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.shard.ShardBase.html b/classes/datastore_core.shard.ShardBase.html index 550b22ce..d90d95ec 100644 --- a/classes/datastore_core.shard.ShardBase.html +++ b/classes/datastore_core.shard.ShardBase.html @@ -1,7 +1,7 @@ -ShardBase | IPFS Stores

                                          Class ShardBase

                                          Hierarchy

                                          Implements

                                          Constructors

                                          constructor +ShardBase | IPFS Stores

                                          Class ShardBase

                                          Hierarchy

                                          Implements

                                          Constructors

                                          constructor

                                          Properties

                                          _padding name param

                                          Methods

                                          fun toString -

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          • fun(s): string

                                          • Parameters

                                            • s: string

                                            Returns string

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          • fun(s): string

                                          • Parameters

                                            • s: string

                                            Returns string

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.shard.Suffix.html b/classes/datastore_core.shard.Suffix.html index 6a9c3089..86579a7d 100644 --- a/classes/datastore_core.shard.Suffix.html +++ b/classes/datastore_core.shard.Suffix.html @@ -1,7 +1,7 @@ -Suffix | IPFS Stores

                                          Class Suffix

                                          Hierarchy

                                          Constructors

                                          constructor +Suffix | IPFS Stores

                                          Class Suffix

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          _padding name param

                                          Methods

                                          fun toString -

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          constructor

                                          Properties

                                          _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.sharding.ShardingDatastore.html b/classes/datastore_core.sharding.ShardingDatastore.html index afd32e20..5ca1912d 100644 --- a/classes/datastore_core.sharding.ShardingDatastore.html +++ b/classes/datastore_core.sharding.ShardingDatastore.html @@ -1,7 +1,7 @@ ShardingDatastore | IPFS Stores

                                          Class ShardingDatastore

                                          Backend independent abstraction of go-ds-flatfs.

                                          Wraps another datastore such that all values are stored sharded according to the given sharding function.

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          child shard

                                          Methods

                                          _all @@ -20,36 +20,36 @@ query queryKeys create -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly child

                                          child: KeyTransformDatastore

                                          Private shard

                                          shard: Shard

                                          Methods

                                          _all

                                          _allKeys

                                          _convertKey

                                          _invertKey

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly child

                                          child: KeyTransformDatastore

                                          Private shard

                                          shard: Shard

                                          Methods

                                          _all

                                          _allKeys

                                          _convertKey

                                          _invertKey

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          deleteMany

                                          deleteMany

                                          • deleteMany(source, options?): AsyncIterable<Key>

                                          • Remove values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            const source = [new Key('awesome')]

                                            for await (const key of store.deleteMany(source)) {
                                              console.log(`deleted content with key ${key}`)
                                            }
                                            -

                                          get

                                          get

                                          getMany

                                          getMany

                                          • getMany(source, options?): AsyncIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<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"
                                            }
                                            -

                                          has

                                          has

                                          • has(key, options?): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          open

                                          put

                                          open

                                          put

                                          putMany

                                          putMany

                                          • putMany(source, options?): AsyncIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            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}`)
                                            }
                                            -

                                          query

                                          query

                                          • query(q, options?): AsyncIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)
                                            -

                                          queryKeys

                                          queryKeys

                                          • queryKeys(q, options?): AsyncIterable<Key>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            // retrieve __all__ keys from the store
                                            let list = []
                                            for await (const key of store.queryKeys({})) {
                                              list.push(key)
                                            }
                                            console.log('ALL THE KEYS', key)
                                            -

                                          Static create

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Static create

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_core.tiered.TieredDatastore.html b/classes/datastore_core.tiered.TieredDatastore.html index c700faab..e042fb7f 100644 --- a/classes/datastore_core.tiered.TieredDatastore.html +++ b/classes/datastore_core.tiered.TieredDatastore.html @@ -2,7 +2,7 @@ will write through to all datastores. Has and get will try each store sequentially. Query will always try the last one first.

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          stores

                                          Methods

                                          _all _allKeys @@ -16,36 +16,36 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly stores

                                          stores: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>[]

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly stores

                                          stores: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>[]

                                          Methods

                                          _all

                                          _allKeys

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          delete

                                          delete

                                          deleteMany

                                          deleteMany

                                          • deleteMany(source, options?): AsyncIterable<Key>

                                          • Remove values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            Example

                                            const source = [new Key('awesome')]

                                            for await (const key of store.deleteMany(source)) {
                                              console.log(`deleted content with key ${key}`)
                                            }
                                            -

                                          get

                                          get

                                          getMany

                                          getMany

                                          has

                                          has

                                          • has(key, options?): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          put

                                          put

                                          putMany

                                          putMany

                                          • putMany(source, options?): AsyncIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            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}`)
                                            }
                                            -

                                          query

                                          query

                                          queryKeys

                                          queryKeys

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_fs.FsDatastore.html b/classes/datastore_fs.FsDatastore.html index da1aed31..2c5e7d9c 100644 --- a/classes/datastore_fs.FsDatastore.html +++ b/classes/datastore_fs.FsDatastore.html @@ -1,7 +1,7 @@ FsDatastore | IPFS Stores

                                          Class FsDatastore

                                          A datastore backed by the file system.

                                          Keys need to be sanitized before use, as they are written to the file system as is.

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          createIfMissing deleteManyConcurrency errorIfExists @@ -25,27 +25,27 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly createIfMissing

                                          createIfMissing: boolean

                                          Private Readonly deleteManyConcurrency

                                          deleteManyConcurrency: number

                                          Private Readonly errorIfExists

                                          errorIfExists: boolean

                                          Private Readonly extension

                                          extension: string

                                          Private Readonly getManyConcurrency

                                          getManyConcurrency: number

                                          path

                                          path: string

                                          Private Readonly putManyConcurrency

                                          putManyConcurrency: number

                                          Methods

                                          _all

                                          _allKeys

                                          _decode

                                          _encode

                                          • _encode(key): {
                                                dir: string;
                                                file: string;
                                            }

                                          • Calculate the directory and file name for a given key.

                                            -

                                            Parameters

                                            Returns {
                                                dir: string;
                                                file: string;
                                            }

                                            • dir: string
                                            • file: string

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly createIfMissing

                                          createIfMissing: boolean

                                          Private Readonly deleteManyConcurrency

                                          deleteManyConcurrency: number

                                          Private Readonly errorIfExists

                                          errorIfExists: boolean

                                          Private Readonly extension

                                          extension: string

                                          Private Readonly getManyConcurrency

                                          getManyConcurrency: number

                                          path

                                          path: string

                                          Private Readonly putManyConcurrency

                                          putManyConcurrency: number

                                          Methods

                                          _all

                                          _allKeys

                                          _decode

                                          _encode

                                          • _encode(key): {
                                                dir: string;
                                                file: string;
                                            }

                                          • Calculate the directory and file name for a given key.

                                            +

                                            Parameters

                                            Returns {
                                                dir: string;
                                                file: string;
                                            }

                                            • dir: string
                                            • file: string

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          close

                                          delete

                                          deleteMany

                                          • deleteMany(source): AsyncIterable<Key>

                                          • Remove values for the passed keys

                                            +

                                          close

                                          delete

                                          deleteMany

                                          get

                                          getMany

                                          get

                                          getMany

                                          • getMany(source): AsyncIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            Returns AsyncIterable<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"
                                            }
                                            -

                                          has

                                          open

                                          put

                                          putMany

                                          has

                                          open

                                          put

                                          putMany

                                          • putMany(source): AsyncIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AsyncIterable<Key>

                                            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}`)
                                            }
                                            -

                                          query

                                          query

                                          • query(q, options?): AwaitIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AwaitIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)

                                          queryKeys

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_level.LevelDatastore.html b/classes/datastore_level.LevelDatastore.html index 464f07dd..23d32b19 100644 --- a/classes/datastore_level.LevelDatastore.html +++ b/classes/datastore_level.LevelDatastore.html @@ -1,5 +1,5 @@ LevelDatastore | IPFS Stores

                                          Class LevelDatastore

                                          A datastore backed by leveldb

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          db opts

                                          Methods

                                          _all @@ -17,36 +17,36 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          db

                                          db: Level<string, Uint8Array>

                                          Private Readonly opts

                                          opts: OpenOptions

                                          Methods

                                          _all

                                          • _all(q, options?): AwaitIterable<Pair>

                                          • Extending classes should override query or implement this method

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          db

                                          db: Level<string, Uint8Array>

                                          Private Readonly opts

                                          opts: OpenOptions

                                          Methods

                                          _all

                                          _allKeys

                                          _query

                                          • _query(opts): AsyncIterable<Pair>

                                          • Parameters

                                            • opts: {
                                                  prefix?: string;
                                                  values: boolean;
                                              }
                                              • Optional prefix?: string
                                              • values: boolean

                                            Returns AsyncIterable<Pair>

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                            Parameters

                                            Returns AwaitIterable<Key>

                                          _query

                                          • _query(opts): AsyncIterable<Pair>

                                          • Parameters

                                            • opts: {
                                                  prefix?: string;
                                                  values: boolean;
                                              }
                                              • Optional prefix?: string
                                              • values: boolean

                                            Returns AsyncIterable<Pair>

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')
                                            -

                                          close

                                          delete

                                          close

                                          delete

                                          deleteMany

                                          deleteMany

                                          get

                                          getMany

                                          getMany

                                          • getMany(source, options?): AwaitIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            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"
                                            }

                                          has

                                          • has(key): Promise<boolean>

                                          • Check for the existence of a value for the passed key

                                            Parameters

                                            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')
                                            }
                                            -

                                          open

                                          put

                                          open

                                          put

                                          putMany

                                          putMany

                                          • putMany(source, options?): AwaitIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AwaitIterable<Key>

                                            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}`)
                                            }

                                          query

                                          • query(q): AsyncIterable<Pair>

                                          • Query the datastore.

                                            Parameters

                                            Returns AsyncIterable<Pair>

                                            Example

                                            // retrieve __all__ key/value pairs from the store
                                            let list = []
                                            for await (const { key, value } of store.query({})) {
                                              list.push(value)
                                            }
                                            console.log('ALL THE VALUES', list)
                                            -

                                          queryKeys

                                          queryKeys

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/datastore_s3.S3Datastore.html b/classes/datastore_s3.S3Datastore.html index 921f04de..fd53c225 100644 --- a/classes/datastore_s3.S3Datastore.html +++ b/classes/datastore_s3.S3Datastore.html @@ -1,5 +1,5 @@ S3Datastore | IPFS Stores

                                          Class S3Datastore

                                          A datastore backed by AWS S3

                                          -

                                          Hierarchy

                                          Constructors

                                          constructor +

                                          Hierarchy

                                          Constructors

                                          constructor

                                          Properties

                                          bucket createIfMissing path? @@ -19,25 +19,25 @@ putMany query queryKeys -

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly bucket

                                          bucket: string

                                          createIfMissing

                                          createIfMissing: boolean

                                          Optional path

                                          path?: string

                                          Private Readonly s3

                                          s3: S3

                                          Methods

                                          _all

                                          _allKeys

                                          _getFullKey

                                          • _getFullKey(key): string

                                          • Returns the full key which includes the path to the ipfs store

                                            -

                                            Parameters

                                            Returns string

                                          _listKeys

                                          • _listKeys(params, options?): AsyncIterable<Key>

                                          • Recursively fetches all keys from s3

                                            -

                                            Parameters

                                            • params: {
                                                  Prefix?: string;
                                                  StartAfter?: string;
                                              }
                                              • Optional Prefix?: string
                                              • Optional StartAfter?: string
                                            • Optional options: AbortOptions

                                            Returns AsyncIterable<Key>

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private Readonly bucket

                                          bucket: string

                                          createIfMissing

                                          createIfMissing: boolean

                                          Optional path

                                          path?: string

                                          Private Readonly s3

                                          s3: S3

                                          Methods

                                          _all

                                          _allKeys

                                          _getFullKey

                                          • _getFullKey(key): string

                                          • Returns the full key which includes the path to the ipfs store

                                            +

                                            Parameters

                                            Returns string

                                          _listKeys

                                          • _listKeys(params, options?): AsyncIterable<Key>

                                          • Recursively fetches all keys from s3

                                            +

                                            Parameters

                                            • params: {
                                                  Prefix?: string;
                                                  StartAfter?: string;
                                              }
                                              • Optional Prefix?: string
                                              • Optional StartAfter?: string
                                            • Optional options: AbortOptions

                                            Returns AsyncIterable<Key>

                                          batch

                                          • batch(): Batch<{}>

                                          • This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

                                            Returns Batch<{}>

                                            Example

                                            const b = store.batch()

                                            for (let i = 0; i < 100; i++) {
                                              b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
                                            }

                                            await b.commit()
                                            console.log('put 100 values')

                                          delete

                                          deleteMany

                                          deleteMany

                                          get

                                          getMany

                                          getMany

                                          • getMany(source, options?): AwaitIterable<Pair>

                                          • Retrieve values for the passed keys

                                            Parameters

                                            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"
                                            }

                                          has

                                          open

                                          put

                                          putMany

                                          open

                                          put

                                          putMany

                                          • putMany(source, options?): AwaitIterable<Key>

                                          • Store the given key/value pairs

                                            Parameters

                                            Returns AwaitIterable<Key>

                                            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}`)
                                            }

                                          query

                                          • query(q, options?): AwaitIterable<Pair>

                                          • Query the datastore.

                                            diff --git a/classes/interface_datastore.key.Key.html b/classes/interface_datastore.key.Key.html index 768c209f..0c75877a 100644 --- a/classes/interface_datastore.key.Key.html +++ b/classes/interface_datastore.key.Key.html @@ -13,7 +13,7 @@
                                          • new Key('/Comedy/MontyPython/Sketch:CheeseShop')
                                          • new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')
                                          -

                                          Constructors

                                          constructor +

                                          Constructors

                                          constructor

                                          Properties

                                          _buf

                                          Accessors

                                          [toStringTag]

                                          Methods

                                          baseNamespace @@ -37,59 +37,59 @@ asKey random withNamespaces -

                                          Constructors

                                          constructor

                                          Properties

                                          Private _buf

                                          _buf: Uint8Array

                                          Accessors

                                          [toStringTag]

                                          Methods

                                          baseNamespace

                                          • baseNamespace(): string

                                          • Returns the "base" namespace of this key.

                                            +

                                          Constructors

                                          constructor

                                          Properties

                                          Private _buf

                                          _buf: Uint8Array

                                          Accessors

                                          [toStringTag]

                                          Methods

                                          baseNamespace

                                          • baseNamespace(): string

                                          • Returns the "base" namespace of this key.

                                            Returns string

                                            Example

                                            new Key('/Comedy/MontyPython/Actor:JohnCleese').baseNamespace()
                                            // => 'Actor:JohnCleese'
                                            -

                                          child

                                          child

                                          • child(key): Key

                                          • Returns the child Key of this Key.

                                            Parameters

                                            • key: Key

                                              The child Key to add

                                            Returns Key

                                            Example

                                            new Key('/Comedy/MontyPython').child(new Key('Actor:JohnCleese'))
                                            // => Key('/Comedy/MontyPython/Actor:JohnCleese')
                                            -

                                          clean

                                          concat

                                          clean

                                          concat

                                          instance

                                          • instance(s): Key

                                          • Returns an "instance" of this type key (appends value to namespace).

                                            +

                                          Returns Key

                                          instance

                                          isAncestorOf

                                          isAncestorOf

                                          isDecendantOf

                                          isDecendantOf

                                          isTopLevel

                                          less

                                          isTopLevel

                                          less

                                          list

                                          Returns boolean

                                          list

                                          name

                                          name

                                          namespaces

                                          parent

                                          namespaces

                                          parent

                                          path

                                          path

                                          reverse

                                          reverse

                                          toString

                                          toString

                                          type

                                          Returns string

                                          type

                                          uint8Array

                                          Static asKey

                                          Static random

                                          uint8Array

                                          Static asKey

                                          Static random

                                          Static withNamespaces

                                          Static withNamespaces

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.abortedError.html b/functions/blockstore_core.errors.abortedError.html index 67fb05f2..7ea22f75 100644 --- a/functions/blockstore_core.errors.abortedError.html +++ b/functions/blockstore_core.errors.abortedError.html @@ -1 +1 @@ -abortedError | IPFS Stores

                                          Function abortedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +abortedError | IPFS Stores

                                          Function abortedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.closeFailedError.html b/functions/blockstore_core.errors.closeFailedError.html index 4b39a91f..0f4567f8 100644 --- a/functions/blockstore_core.errors.closeFailedError.html +++ b/functions/blockstore_core.errors.closeFailedError.html @@ -1 +1 @@ -closeFailedError | IPFS Stores

                                          Function closeFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +closeFailedError | IPFS Stores

                                          Function closeFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.deleteFailedError.html b/functions/blockstore_core.errors.deleteFailedError.html index 491860f3..2a94a5c2 100644 --- a/functions/blockstore_core.errors.deleteFailedError.html +++ b/functions/blockstore_core.errors.deleteFailedError.html @@ -1 +1 @@ -deleteFailedError | IPFS Stores

                                          Function deleteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +deleteFailedError | IPFS Stores

                                          Function deleteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.getFailedError.html b/functions/blockstore_core.errors.getFailedError.html index 27234f2d..9cc8875d 100644 --- a/functions/blockstore_core.errors.getFailedError.html +++ b/functions/blockstore_core.errors.getFailedError.html @@ -1 +1 @@ -getFailedError | IPFS Stores

                                          Function getFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +getFailedError | IPFS Stores

                                          Function getFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.hasFailedError.html b/functions/blockstore_core.errors.hasFailedError.html index 8376222c..40115728 100644 --- a/functions/blockstore_core.errors.hasFailedError.html +++ b/functions/blockstore_core.errors.hasFailedError.html @@ -1 +1 @@ -hasFailedError | IPFS Stores

                                          Function hasFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +hasFailedError | IPFS Stores

                                          Function hasFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.notFoundError.html b/functions/blockstore_core.errors.notFoundError.html index 5182921f..ebf90363 100644 --- a/functions/blockstore_core.errors.notFoundError.html +++ b/functions/blockstore_core.errors.notFoundError.html @@ -1 +1 @@ -notFoundError | IPFS Stores

                                          Function notFoundError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +notFoundError | IPFS Stores

                                          Function notFoundError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.openFailedError.html b/functions/blockstore_core.errors.openFailedError.html index 62253f0e..b18c0042 100644 --- a/functions/blockstore_core.errors.openFailedError.html +++ b/functions/blockstore_core.errors.openFailedError.html @@ -1 +1 @@ -openFailedError | IPFS Stores

                                          Function openFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +openFailedError | IPFS Stores

                                          Function openFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/blockstore_core.errors.putFailedError.html b/functions/blockstore_core.errors.putFailedError.html index 2d8a94f5..e151a76a 100644 --- a/functions/blockstore_core.errors.putFailedError.html +++ b/functions/blockstore_core.errors.putFailedError.html @@ -1 +1 @@ -putFailedError | IPFS Stores

                                          Function putFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +putFailedError | IPFS Stores

                                          Function putFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.abortedError.html b/functions/datastore_core.errors.abortedError.html index 78717e68..e33cc830 100644 --- a/functions/datastore_core.errors.abortedError.html +++ b/functions/datastore_core.errors.abortedError.html @@ -1 +1 @@ -abortedError | IPFS Stores

                                          Function abortedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +abortedError | IPFS Stores

                                          Function abortedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.dbDeleteFailedError.html b/functions/datastore_core.errors.dbDeleteFailedError.html index a44e76d5..e7f368a8 100644 --- a/functions/datastore_core.errors.dbDeleteFailedError.html +++ b/functions/datastore_core.errors.dbDeleteFailedError.html @@ -1 +1 @@ -dbDeleteFailedError | IPFS Stores

                                          Function dbDeleteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +dbDeleteFailedError | IPFS Stores

                                          Function dbDeleteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.dbOpenFailedError.html b/functions/datastore_core.errors.dbOpenFailedError.html index c39f725e..ffa3f8e8 100644 --- a/functions/datastore_core.errors.dbOpenFailedError.html +++ b/functions/datastore_core.errors.dbOpenFailedError.html @@ -1 +1 @@ -dbOpenFailedError | IPFS Stores

                                          Function dbOpenFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +dbOpenFailedError | IPFS Stores

                                          Function dbOpenFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.dbReadFailedError.html b/functions/datastore_core.errors.dbReadFailedError.html index b7e77a9d..ad77edc2 100644 --- a/functions/datastore_core.errors.dbReadFailedError.html +++ b/functions/datastore_core.errors.dbReadFailedError.html @@ -1 +1 @@ -dbReadFailedError | IPFS Stores

                                          Function dbReadFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +dbReadFailedError | IPFS Stores

                                          Function dbReadFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.dbWriteFailedError.html b/functions/datastore_core.errors.dbWriteFailedError.html index 8c8b6eab..f96e2032 100644 --- a/functions/datastore_core.errors.dbWriteFailedError.html +++ b/functions/datastore_core.errors.dbWriteFailedError.html @@ -1 +1 @@ -dbWriteFailedError | IPFS Stores

                                          Function dbWriteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +dbWriteFailedError | IPFS Stores

                                          Function dbWriteFailedError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.errors.notFoundError.html b/functions/datastore_core.errors.notFoundError.html index 50e05edb..f2fe6b91 100644 --- a/functions/datastore_core.errors.notFoundError.html +++ b/functions/datastore_core.errors.notFoundError.html @@ -1 +1 @@ -notFoundError | IPFS Stores

                                          Function notFoundError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +notFoundError | IPFS Stores

                                          Function notFoundError

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.shard.parseShardFun.html b/functions/datastore_core.shard.parseShardFun.html index c0041e38..9b2ac064 100644 --- a/functions/datastore_core.shard.parseShardFun.html +++ b/functions/datastore_core.shard.parseShardFun.html @@ -1,2 +1,2 @@ parseShardFun | IPFS Stores

                                          Function parseShardFun

                                          • parseShardFun(str): Shard

                                          • Convert a given string to the matching sharding function

                                            -

                                            Parameters

                                            • str: string

                                            Returns Shard

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Shard

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/datastore_core.shard.readShardFun.html b/functions/datastore_core.shard.readShardFun.html index 089b78a7..063f6f1d 100644 --- a/functions/datastore_core.shard.readShardFun.html +++ b/functions/datastore_core.shard.readShardFun.html @@ -1 +1 @@ -readShardFun | IPFS Stores

                                          Function readShardFun

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +readShardFun | IPFS Stores

                                          Function readShardFun

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/interface_blockstore_tests.interfaceBlockstoreTests.html b/functions/interface_blockstore_tests.interfaceBlockstoreTests.html index ddc9fc55..572eaa9d 100644 --- a/functions/interface_blockstore_tests.interfaceBlockstoreTests.html +++ b/functions/interface_blockstore_tests.interfaceBlockstoreTests.html @@ -1 +1 @@ -interfaceBlockstoreTests | IPFS Stores

                                          Function interfaceBlockstoreTests

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +interfaceBlockstoreTests | IPFS Stores

                                          Function interfaceBlockstoreTests

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/functions/interface_datastore_tests.interfaceDatastoreTests.html b/functions/interface_datastore_tests.interfaceDatastoreTests.html index 9d2faf1c..fb10dcee 100644 --- a/functions/interface_datastore_tests.interfaceDatastoreTests.html +++ b/functions/interface_datastore_tests.interfaceDatastoreTests.html @@ -1 +1 @@ -interfaceDatastoreTests | IPFS Stores

                                          Function interfaceDatastoreTests

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file +interfaceDatastoreTests | IPFS Stores

                                          Function interfaceDatastoreTests

                                          Settings

                                          Member Visibility

                                          Theme

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_fs.index.FsBlockstoreInit.html b/interfaces/blockstore_fs.index.FsBlockstoreInit.html index ea314b2e..15bb5831 100644 --- a/interfaces/blockstore_fs.index.FsBlockstoreInit.html +++ b/interfaces/blockstore_fs.index.FsBlockstoreInit.html @@ -1,4 +1,4 @@ -FsBlockstoreInit | IPFS Stores

                                          Interface FsBlockstoreInit

                                          interface FsBlockstoreInit {
                                              createIfMissing?: boolean;
                                              deleteManyConcurrency?: number;
                                              errorIfExists?: boolean;
                                              extension?: string;
                                              getManyConcurrency?: number;
                                              putManyConcurrency?: number;
                                              shardingStrategy?: ShardingStrategy;
                                          }

                                          Properties

                                          createIfMissing? +FsBlockstoreInit | IPFS Stores

                                          Interface FsBlockstoreInit

                                          interface FsBlockstoreInit {
                                              createIfMissing?: boolean;
                                              deleteManyConcurrency?: number;
                                              errorIfExists?: boolean;
                                              extension?: string;
                                              getManyConcurrency?: number;
                                              putManyConcurrency?: number;
                                              shardingStrategy?: ShardingStrategy;
                                          }

                                          Properties

                                          createIfMissing? deleteManyConcurrency? errorIfExists? extension? @@ -7,14 +7,14 @@ shardingStrategy?

                                          Properties

                                          Optional createIfMissing

                                          createIfMissing?: boolean

                                          If true and the passed blockstore location does not exist, create it on startup. default: true

                                          -

                                          Optional deleteManyConcurrency

                                          deleteManyConcurrency?: number

                                          How many blocks to delete in parallel when .deleteMany is called. +

                                          Optional deleteManyConcurrency

                                          deleteManyConcurrency?: number

                                          How many blocks to delete in parallel when .deleteMany is called. default: 50

                                          -

                                          Optional errorIfExists

                                          errorIfExists?: boolean

                                          If true and the passed blockstore location exists on startup, throw +

                                          Optional errorIfExists

                                          errorIfExists?: boolean

                                          If true and the passed blockstore location exists on startup, throw an error. default: false

                                          -

                                          Optional extension

                                          extension?: string

                                          The file extension to use when storing blocks. default: '.data'

                                          -

                                          Optional getManyConcurrency

                                          getManyConcurrency?: number

                                          How many blocks to read in parallel when .getMany is called. +

                                          Optional extension

                                          extension?: string

                                          The file extension to use when storing blocks. default: '.data'

                                          +

                                          Optional getManyConcurrency

                                          getManyConcurrency?: number

                                          How many blocks to read in parallel when .getMany is called. default: 50

                                          -

                                          Optional putManyConcurrency

                                          putManyConcurrency?: number

                                          How many blocks to put in parallel when .putMany is called. +

                                          Optional putManyConcurrency

                                          putManyConcurrency?: number

                                          How many blocks to put in parallel when .putMany is called. default: 50

                                          -

                                          Optional shardingStrategy

                                          shardingStrategy?: ShardingStrategy

                                          Control how CIDs map to paths and back

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional shardingStrategy

                                          shardingStrategy?: ShardingStrategy

                                          Control how CIDs map to paths and back

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html b/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html index 155dd1f8..cb5fecbb 100644 --- a/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html +++ b/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html @@ -1,8 +1,8 @@ -FlatDirectoryInit | IPFS Stores

                                          Interface FlatDirectoryInit

                                          interface FlatDirectoryInit {
                                              base?: MultibaseCodec<string>;
                                              extension?: string;
                                              prefixLength?: number;
                                          }

                                          Properties

                                          base? +FlatDirectoryInit | IPFS Stores

                                          Interface FlatDirectoryInit

                                          interface FlatDirectoryInit {
                                              base?: MultibaseCodec<string>;
                                              extension?: string;
                                              prefixLength?: number;
                                          }

                                          Properties

                                          base? extension? prefixLength?

                                          Properties

                                          Optional base

                                          base?: MultibaseCodec<string>

                                          The multibase codec to use - nb. should be case insensitive. default: base32padupper

                                          -

                                          Optional extension

                                          extension?: string

                                          The file extension to use. default: '.data'

                                          -

                                          Optional prefixLength

                                          prefixLength?: number

                                          How many characters to take from the end of the CID. default: 2

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional extension

                                          extension?: string

                                          The file extension to use. default: '.data'

                                          +

                                          Optional prefixLength

                                          prefixLength?: number

                                          How many characters to take from the end of the CID. default: 2

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.NextToLastInit.html b/interfaces/blockstore_fs.sharding.NextToLastInit.html index 063db95a..b03a4c7e 100644 --- a/interfaces/blockstore_fs.sharding.NextToLastInit.html +++ b/interfaces/blockstore_fs.sharding.NextToLastInit.html @@ -1,8 +1,8 @@ -NextToLastInit | IPFS Stores

                                          Interface NextToLastInit

                                          interface NextToLastInit {
                                              base?: MultibaseCodec<string>;
                                              extension?: string;
                                              prefixLength?: number;
                                          }

                                          Properties

                                          base? +NextToLastInit | IPFS Stores

                                          Interface NextToLastInit

                                          interface NextToLastInit {
                                              base?: MultibaseCodec<string>;
                                              extension?: string;
                                              prefixLength?: number;
                                          }

                                          Properties

                                          base? extension? prefixLength?

                                          Properties

                                          Optional base

                                          base?: MultibaseCodec<string>

                                          The multibase codec to use - nb. should be case insensitive. default: base32upper

                                          -

                                          Optional extension

                                          extension?: string

                                          The file extension to use. default: '.data'

                                          -

                                          Optional prefixLength

                                          prefixLength?: number

                                          How many characters to take from the end of the CID. default: 2

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional extension

                                          extension?: string

                                          The file extension to use. default: '.data'

                                          +

                                          Optional prefixLength

                                          prefixLength?: number

                                          How many characters to take from the end of the CID. default: 2

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.ShardingStrategy.html b/interfaces/blockstore_fs.sharding.ShardingStrategy.html index 1cf056f4..d6e47e39 100644 --- a/interfaces/blockstore_fs.sharding.ShardingStrategy.html +++ b/interfaces/blockstore_fs.sharding.ShardingStrategy.html @@ -1,4 +1,4 @@ -ShardingStrategy | IPFS Stores

                                          Interface ShardingStrategy

                                          interface ShardingStrategy {
                                              extension: string;
                                              decode(path): CID<unknown, number, number, Version>;
                                              encode(cid): {
                                                  dir: string;
                                                  file: string;
                                              };
                                          }

                                          Implemented by

                                          Properties

                                          extension +ShardingStrategy | IPFS Stores

                                          Interface ShardingStrategy

                                          interface ShardingStrategy {
                                              extension: string;
                                              decode(path): CID<unknown, number, number, Version>;
                                              encode(cid): {
                                                  dir: string;
                                                  file: string;
                                              };
                                          }

                                          Implemented by

                                          Properties

                                          extension

                                          Methods

                                          decode encode -

                                          Properties

                                          extension

                                          extension: string

                                          Methods

                                          decode

                                          encode

                                          • encode(cid): {
                                                dir: string;
                                                file: string;
                                            }

                                          • Parameters

                                            Returns {
                                                dir: string;
                                                file: string;
                                            }

                                            • dir: string
                                            • file: string

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Properties

                                          extension

                                          extension: string

                                          Methods

                                          decode

                                          encode

                                          • encode(cid): {
                                                dir: string;
                                                file: string;
                                            }

                                          • Parameters

                                            Returns {
                                                dir: string;
                                                file: string;
                                            }

                                            • dir: string
                                            • file: string

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_idb.IDBBlockstoreInit.html b/interfaces/blockstore_idb.IDBBlockstoreInit.html index 69aa26de..bdd65238 100644 --- a/interfaces/blockstore_idb.IDBBlockstoreInit.html +++ b/interfaces/blockstore_idb.IDBBlockstoreInit.html @@ -1,8 +1,8 @@ -IDBBlockstoreInit | IPFS Stores

                                          Interface IDBBlockstoreInit

                                          interface IDBBlockstoreInit {
                                              base?: MultibaseCodec<string>;
                                              prefix?: string;
                                              version?: number;
                                          }

                                          Properties

                                          base? +IDBBlockstoreInit | IPFS Stores

                                          Interface IDBBlockstoreInit

                                          interface IDBBlockstoreInit {
                                              base?: MultibaseCodec<string>;
                                              prefix?: string;
                                              version?: number;
                                          }

                                          Properties

                                          base? prefix? version?

                                          Properties

                                          Optional base

                                          base?: MultibaseCodec<string>

                                          The multibase codec to use - nb. should be case insensitive. (default: base32upper)

                                          -

                                          Optional prefix

                                          prefix?: string

                                          A prefix to use for all database keys (default: '')

                                          -

                                          Optional version

                                          version?: number

                                          The database version (default: 1)

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional prefix

                                          prefix?: string

                                          A prefix to use for all database keys (default: '')

                                          +

                                          Optional version

                                          version?: number

                                          The database version (default: 1)

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_level.LevelBlockstoreInit.html b/interfaces/blockstore_level.LevelBlockstoreInit.html index c90729ea..3070830c 100644 --- a/interfaces/blockstore_level.LevelBlockstoreInit.html +++ b/interfaces/blockstore_level.LevelBlockstoreInit.html @@ -1,4 +1,4 @@ -LevelBlockstoreInit | IPFS Stores

                                          Interface LevelBlockstoreInit

                                          interface LevelBlockstoreInit {
                                              base?: MultibaseCodec<string>;
                                              blockRestartInterval?: number;
                                              blockSize?: number;
                                              cacheSize?: number;
                                              compression?: boolean;
                                              createIfMissing?: boolean;
                                              errorIfExists?: boolean;
                                              keyEncoding?: string | PartialEncoding<string, string>;
                                              maxFileSize?: number;
                                              maxOpenFiles?: number;
                                              passive?: boolean;
                                              prefix?: string;
                                              valueEncoding?: string | PartialEncoding<Uint8Array, Uint8Array>;
                                              version?: string | number;
                                              writeBufferSize?: number;
                                          }

                                          Hierarchy

                                          Properties

                                          base? +LevelBlockstoreInit | IPFS Stores

                                          Interface LevelBlockstoreInit

                                          interface LevelBlockstoreInit {
                                              base?: MultibaseCodec<string>;
                                              blockRestartInterval?: number;
                                              blockSize?: number;
                                              cacheSize?: number;
                                              compression?: boolean;
                                              createIfMissing?: boolean;
                                              errorIfExists?: boolean;
                                              keyEncoding?: string | PartialEncoding<string, string>;
                                              maxFileSize?: number;
                                              maxOpenFiles?: number;
                                              passive?: boolean;
                                              prefix?: string;
                                              valueEncoding?: string | PartialEncoding<Uint8Array, Uint8Array>;
                                              version?: string | number;
                                              writeBufferSize?: number;
                                          }

                                          Hierarchy

                                          Properties

                                          base? blockRestartInterval? blockSize? cacheSize? @@ -15,7 +15,7 @@ writeBufferSize?

                                          Properties

                                          Optional base

                                          base?: MultibaseCodec<string>

                                          The multibase codec to use - nb. should be case insensitive. default: base32upper

                                          -

                                          Optional blockRestartInterval

                                          blockRestartInterval?: number

                                          The number of entries before restarting the "delta encoding" of keys +

                                          Optional blockRestartInterval

                                          blockRestartInterval?: number

                                          The number of entries before restarting the "delta encoding" of keys within blocks. Each "restart" point stores the full key for the entry, between restarts, the common prefix of the keys for those entries is omitted. Restarts are similar to the concept of keyframes in video diff --git a/interfaces/blockstore_s3.S3BlockstoreInit.html b/interfaces/blockstore_s3.S3BlockstoreInit.html index be542822..b31e5c46 100644 --- a/interfaces/blockstore_s3.S3BlockstoreInit.html +++ b/interfaces/blockstore_s3.S3BlockstoreInit.html @@ -1,5 +1,5 @@ -S3BlockstoreInit | IPFS Stores

                                          Interface S3BlockstoreInit

                                          interface S3BlockstoreInit {
                                              createIfMissing?: boolean;
                                              shardingStrategy?: ShardingStrategy;
                                          }

                                          Properties

                                          createIfMissing? +S3BlockstoreInit | IPFS Stores

                                          Interface S3BlockstoreInit

                                          interface S3BlockstoreInit {
                                              createIfMissing?: boolean;
                                              shardingStrategy?: ShardingStrategy;
                                          }

                                          Properties

                                          createIfMissing? shardingStrategy?

                                          Properties

                                          Optional createIfMissing

                                          createIfMissing?: boolean

                                          Whether to try to create the bucket if it is missing when .open is called

                                          -

                                          Optional shardingStrategy

                                          shardingStrategy?: ShardingStrategy

                                          Control how CIDs map to paths and back

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional shardingStrategy

                                          shardingStrategy?: ShardingStrategy

                                          Control how CIDs map to paths and back

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/blockstore_s3.ShardingStrategy.html b/interfaces/blockstore_s3.ShardingStrategy.html index 6e27f812..de7b6ec7 100644 --- a/interfaces/blockstore_s3.ShardingStrategy.html +++ b/interfaces/blockstore_s3.ShardingStrategy.html @@ -1,4 +1,4 @@ -ShardingStrategy | IPFS Stores

                                          Interface ShardingStrategy

                                          interface ShardingStrategy {
                                              extension: string;
                                              decode(path): CID<unknown, number, number, Version>;
                                              encode(cid): string;
                                          }

                                          Properties

                                          extension +ShardingStrategy | IPFS Stores

                                          Interface ShardingStrategy

                                          interface ShardingStrategy {
                                              extension: string;
                                              decode(path): CID<unknown, number, number, Version>;
                                              encode(cid): string;
                                          }

                                          Properties

                                          extension

                                          Methods

                                          decode encode -

                                          Properties

                                          extension

                                          extension: string

                                          Methods

                                          decode

                                          encode

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Properties

                                          extension

                                          extension: string

                                          Methods

                                          decode

                                          encode

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/datastore_core.index.KeyTransform.html b/interfaces/datastore_core.index.KeyTransform.html index b64b9dd3..cbd5e04e 100644 --- a/interfaces/datastore_core.index.KeyTransform.html +++ b/interfaces/datastore_core.index.KeyTransform.html @@ -1,3 +1,3 @@ -KeyTransform | IPFS Stores

                                          Interface KeyTransform

                                          interface KeyTransform {
                                              convert(key): Key;
                                              invert(key): Key;
                                          }

                                          Methods

                                          convert +KeyTransform | IPFS Stores

                                          Interface KeyTransform

                                          interface KeyTransform {
                                              convert(key): Key;
                                              invert(key): Key;
                                          }

                                          Methods

                                          convert invert -

                                          Methods

                                          convert

                                          invert

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Methods

                                          convert

                                          invert

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/datastore_core.index.Shard-1.html b/interfaces/datastore_core.index.Shard-1.html index 5a7cb159..706ae7a5 100644 --- a/interfaces/datastore_core.index.Shard-1.html +++ b/interfaces/datastore_core.index.Shard-1.html @@ -1,6 +1,6 @@ -Shard | IPFS Stores

                                          Interface Shard

                                          interface Shard {
                                              _padding: string;
                                              name: string;
                                              param: number;
                                              fun(s): string;
                                              toString(): string;
                                          }

                                          Implemented by

                                          Properties

                                          _padding +Shard | IPFS Stores

                                          Interface Shard

                                          interface Shard {
                                              _padding: string;
                                              name: string;
                                              param: number;
                                              fun(s): string;
                                              toString(): string;
                                          }

                                          Implemented by

                                          Properties

                                          _padding name param

                                          Methods

                                          fun toString -

                                          Properties

                                          Readonly _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          • fun(s): string

                                          • Parameters

                                            • s: string

                                            Returns string

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Properties

                                          Readonly _padding

                                          _padding: string

                                          name

                                          name: string

                                          param

                                          param: number

                                          Methods

                                          fun

                                          • fun(s): string

                                          • Parameters

                                            • s: string

                                            Returns string

                                          toString

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/datastore_fs.FsDatastoreInit.html b/interfaces/datastore_fs.FsDatastoreInit.html index c02c3232..e6b17fe7 100644 --- a/interfaces/datastore_fs.FsDatastoreInit.html +++ b/interfaces/datastore_fs.FsDatastoreInit.html @@ -1,7 +1,7 @@ -FsDatastoreInit | IPFS Stores

                                          Interface FsDatastoreInit

                                          interface FsDatastoreInit {
                                              createIfMissing?: boolean;
                                              deleteManyConcurrency?: number;
                                              errorIfExists?: boolean;
                                              extension?: string;
                                              getManyConcurrency?: number;
                                              putManyConcurrency?: number;
                                          }

                                          Properties

                                          createIfMissing? +FsDatastoreInit | IPFS Stores

                                          Interface FsDatastoreInit

                                          interface FsDatastoreInit {
                                              createIfMissing?: boolean;
                                              deleteManyConcurrency?: number;
                                              errorIfExists?: boolean;
                                              extension?: string;
                                              getManyConcurrency?: number;
                                              putManyConcurrency?: number;
                                          }

                                          Properties

                                          createIfMissing? deleteManyConcurrency? errorIfExists? extension? getManyConcurrency? putManyConcurrency? -

                                          Properties

                                          Optional createIfMissing

                                          createIfMissing?: boolean

                                          Optional deleteManyConcurrency

                                          deleteManyConcurrency?: number

                                          Optional errorIfExists

                                          errorIfExists?: boolean

                                          Optional extension

                                          extension?: string

                                          Optional getManyConcurrency

                                          getManyConcurrency?: number

                                          Optional putManyConcurrency

                                          putManyConcurrency?: number

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Properties

                                          Optional createIfMissing

                                          createIfMissing?: boolean

                                          Optional deleteManyConcurrency

                                          deleteManyConcurrency?: number

                                          Optional errorIfExists

                                          errorIfExists?: boolean

                                          Optional extension

                                          extension?: string

                                          Optional getManyConcurrency

                                          getManyConcurrency?: number

                                          Optional putManyConcurrency

                                          putManyConcurrency?: number

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/datastore_idb.IDBDatastoreInit.html b/interfaces/datastore_idb.IDBDatastoreInit.html index 431faa0c..4336d31e 100644 --- a/interfaces/datastore_idb.IDBDatastoreInit.html +++ b/interfaces/datastore_idb.IDBDatastoreInit.html @@ -1,5 +1,5 @@ -IDBDatastoreInit | IPFS Stores

                                          Interface IDBDatastoreInit

                                          interface IDBDatastoreInit {
                                              prefix?: string;
                                              version?: number;
                                          }

                                          Properties

                                          prefix? +IDBDatastoreInit | IPFS Stores

                                          Interface IDBDatastoreInit

                                          interface IDBDatastoreInit {
                                              prefix?: string;
                                              version?: number;
                                          }

                                          Properties

                                          prefix? version?

                                          Properties

                                          Optional prefix

                                          prefix?: string

                                          A prefix to use for all database keys (default: '')

                                          -

                                          Optional version

                                          version?: number

                                          The database version (default: 1)

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Optional version

                                          version?: number

                                          The database version (default: 1)

                                          +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/datastore_s3.S3DatastoreInit.html b/interfaces/datastore_s3.S3DatastoreInit.html index 31967b63..2689adba 100644 --- a/interfaces/datastore_s3.S3DatastoreInit.html +++ b/interfaces/datastore_s3.S3DatastoreInit.html @@ -1,10 +1,10 @@ -S3DatastoreInit | IPFS Stores

                                          Interface S3DatastoreInit

                                          interface S3DatastoreInit {
                                              createIfMissing?: boolean;
                                              path?: string;
                                          }

                                          Properties

                                          createIfMissing? +S3DatastoreInit | IPFS Stores

                                          Interface S3DatastoreInit

                                          interface S3DatastoreInit {
                                              createIfMissing?: boolean;
                                              path?: string;
                                          }

                                          Properties

                                          createIfMissing? path?

                                          Properties

                                          Optional createIfMissing

                                          createIfMissing?: boolean

                                          Whether to try to create the bucket if it is missing when .open is called

                                          -

                                          Optional path

                                          path?: string

                                          An optional path to use within the bucket for all files - this setting can +

                                          Optional path

                                          path?: string

                                          An optional path to use within the bucket for all files - this setting can affect S3 performance as it does internal sharding based on 'prefixes' - these can be delimited by '/' so it's often better to wrap this datastore in a sharding datastore which will generate prefixed datastore keys for you.

                                          See - https://docs.aws.amazon.com/AmazonS3/latest/userguide/optimizing-performance.html and https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html

                                          -

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/interface_blockstore.Blockstore.html b/interfaces/interface_blockstore.Blockstore.html index 35a61013..a0c44147 100644 --- a/interfaces/interface_blockstore.Blockstore.html +++ b/interfaces/interface_blockstore.Blockstore.html @@ -1,4 +1,4 @@ -Blockstore | IPFS Stores

                                          Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

                                          interface Blockstore {
                                              delete(key, options?): Await<void>;
                                              deleteMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>;
                                              get(key, options?): Await<Uint8Array>;
                                              getAll(options?): AwaitIterable<Pair>;
                                              getMany(source, options?): AwaitIterable<Pair>;
                                              has(key, options?): Await<boolean>;
                                              put(key, val, options?): Await<CID<unknown, number, number, Version>>;
                                              putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>;
                                          }

                                          Type Parameters

                                          • HasOptionsExtension = {}

                                          • PutOptionsExtension = {}

                                          • PutManyOptionsExtension = {}

                                          • GetOptionsExtension = {}

                                          • GetManyOptionsExtension = {}

                                          • GetAllOptionsExtension = {}

                                          • DeleteOptionsExtension = {}

                                          • DeleteManyOptionsExtension = {}

                                          Hierarchy

                                          • Store<CID, Uint8Array, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>
                                            • Blockstore

                                          Implemented by

                                            Methods

                                            delete +Blockstore | IPFS Stores

                                            Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

                                            interface Blockstore {
                                                delete(key, options?): Await<void>;
                                                deleteMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>;
                                                get(key, options?): Await<Uint8Array>;
                                                getAll(options?): AwaitIterable<Pair>;
                                                getMany(source, options?): AwaitIterable<Pair>;
                                                has(key, options?): Await<boolean>;
                                                put(key, val, options?): Await<CID<unknown, number, number, Version>>;
                                                putMany(source, options?): AwaitIterable<CID<unknown, number, number, Version>>;
                                            }

                                            Type Parameters

                                            • HasOptionsExtension = {}

                                            • PutOptionsExtension = {}

                                            • PutManyOptionsExtension = {}

                                            • GetOptionsExtension = {}

                                            • GetManyOptionsExtension = {}

                                            • GetAllOptionsExtension = {}

                                            • DeleteOptionsExtension = {}

                                            • DeleteManyOptionsExtension = {}

                                            Hierarchy

                                            • Store<CID, Uint8Array, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>
                                              • Blockstore

                                            Implemented by

                                              Methods

                                              delete deleteMany get getAll @@ -18,7 +18,7 @@

                                              getAll

                                              • getAll(options?): AwaitIterable<Pair>

                                              • Retrieve all cid/block pairs from the blockstore as an unordered iterable

                                                Parameters

                                                Returns AwaitIterable<Pair>

                                                Example

                                                for await (const { multihash, block } of store.getAll()) {
                                                  console.log('got:', multihash, block)
                                                  // => got MultihashDigest('Qmfoo') Uint8Array[...]
                                                }
                                                -

                                              getMany

                                              getMany

                                              • getMany(source, options?): AwaitIterable<Pair>

                                              • Retrieve values for the passed keys

                                                Parameters

                                                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"
                                                }

                                              has

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQuery.html b/interfaces/interface_datastore.index.KeyQuery.html index bef30195..98da236e 100644 --- a/interfaces/interface_datastore.index.KeyQuery.html +++ b/interfaces/interface_datastore.index.KeyQuery.html @@ -1,6 +1,6 @@ -KeyQuery | IPFS Stores

                                              Interface KeyQuery

                                              interface KeyQuery {
                                                  filters?: KeyQueryFilter[];
                                                  limit?: number;
                                                  offset?: number;
                                                  orders?: KeyQueryOrder[];
                                                  prefix?: string;
                                              }

                                              Properties

                                              filters? +KeyQuery | IPFS Stores

                                              Interface KeyQuery

                                              interface KeyQuery {
                                                  filters?: KeyQueryFilter[];
                                                  limit?: number;
                                                  offset?: number;
                                                  orders?: KeyQueryOrder[];
                                                  prefix?: string;
                                              }

                                              Properties

                                              filters? limit? offset? orders? prefix? -

                                              Properties

                                              Optional filters

                                              filters?: KeyQueryFilter[]

                                              Optional limit

                                              limit?: number

                                              Optional offset

                                              offset?: number

                                              Optional orders

                                              orders?: KeyQueryOrder[]

                                              Optional prefix

                                              prefix?: string

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file +

                                              Properties

                                              Optional filters

                                              filters?: KeyQueryFilter[]

                                              Optional limit

                                              limit?: number

                                              Optional offset

                                              offset?: number

                                              Optional orders

                                              orders?: KeyQueryOrder[]

                                              Optional prefix

                                              prefix?: string

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryFilter.html b/interfaces/interface_datastore.index.KeyQueryFilter.html index b8dfbe6f..a878165e 100644 --- a/interfaces/interface_datastore.index.KeyQueryFilter.html +++ b/interfaces/interface_datastore.index.KeyQueryFilter.html @@ -1 +1 @@ -KeyQueryFilter | IPFS Stores

                                              Interface KeyQueryFilter

                                              interface KeyQueryFilter ((item) => boolean)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file +KeyQueryFilter | IPFS Stores

                                              Interface KeyQueryFilter

                                              interface KeyQueryFilter ((item) => boolean)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryOrder.html b/interfaces/interface_datastore.index.KeyQueryOrder.html index 47957129..bfa8bdd7 100644 --- a/interfaces/interface_datastore.index.KeyQueryOrder.html +++ b/interfaces/interface_datastore.index.KeyQueryOrder.html @@ -1 +1 @@ -KeyQueryOrder | IPFS Stores

                                              Interface KeyQueryOrder

                                              interface KeyQueryOrder ((a, b) => 0 | 1 | -1)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file +KeyQueryOrder | IPFS Stores

                                              Interface KeyQueryOrder

                                              interface KeyQueryOrder ((a, b) => 0 | 1 | -1)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Pair.html b/interfaces/interface_datastore.index.Pair.html index 5abf772d..771011c9 100644 --- a/interfaces/interface_datastore.index.Pair.html +++ b/interfaces/interface_datastore.index.Pair.html @@ -1,3 +1,3 @@ -Pair | IPFS Stores

                                              Interface Pair

                                              interface Pair {
                                                  key: Key;
                                                  value: Uint8Array;
                                              }

                                              Properties

                                              key +Pair | IPFS Stores

                                              Interface Pair

                                              interface Pair {
                                                  key: Key;
                                                  value: Uint8Array;
                                              }

                                              Properties

                                              key value -

                                              Properties

                                              key

                                              key: Key

                                              value

                                              value: Uint8Array

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file +

                                              Properties

                                              key

                                              key: Key

                                              value

                                              value: Uint8Array

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Query.html b/interfaces/interface_datastore.index.Query.html index ffdf95bf..8b14412f 100644 --- a/interfaces/interface_datastore.index.Query.html +++ b/interfaces/interface_datastore.index.Query.html @@ -1,6 +1,6 @@ -Query | IPFS Stores

                                              Interface Query

                                              interface Query {
                                                  filters?: QueryFilter[];
                                                  limit?: number;
                                                  offset?: number;
                                                  orders?: QueryOrder[];
                                                  prefix?: string;
                                              }

                                              Properties

                                              filters? +Query | IPFS Stores

                                              Interface Query

                                              interface Query {
                                                  filters?: QueryFilter[];
                                                  limit?: number;
                                                  offset?: number;
                                                  orders?: QueryOrder[];
                                                  prefix?: string;
                                              }

                                              Properties

                                              filters? limit? offset? orders? prefix? -

                                              Properties

                                              Optional filters

                                              filters?: QueryFilter[]

                                              Optional limit

                                              limit?: number

                                              Optional offset

                                              offset?: number

                                              Optional orders

                                              orders?: QueryOrder[]

                                              Optional prefix

                                              prefix?: string

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file +

                                              Properties

                                              Optional filters

                                              filters?: QueryFilter[]

                                              Optional limit

                                              limit?: number

                                              Optional offset

                                              offset?: number

                                              Optional orders

                                              orders?: QueryOrder[]

                                              Optional prefix

                                              prefix?: string

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryFilter.html b/interfaces/interface_datastore.index.QueryFilter.html index 172be30d..b980dc89 100644 --- a/interfaces/interface_datastore.index.QueryFilter.html +++ b/interfaces/interface_datastore.index.QueryFilter.html @@ -1 +1 @@ -QueryFilter | IPFS Stores

                                              Interface QueryFilter

                                              interface QueryFilter ((item) => boolean)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file +QueryFilter | IPFS Stores

                                              Interface QueryFilter

                                              interface QueryFilter ((item) => boolean)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryOrder.html b/interfaces/interface_datastore.index.QueryOrder.html index 1ed9a7a9..da24bd6d 100644 --- a/interfaces/interface_datastore.index.QueryOrder.html +++ b/interfaces/interface_datastore.index.QueryOrder.html @@ -1 +1 @@ -QueryOrder | IPFS Stores

                                              Interface QueryOrder

                                              interface QueryOrder ((a, b) => 0 | 1 | -1)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file +QueryOrder | IPFS Stores

                                              Interface QueryOrder

                                              interface QueryOrder ((a, b) => 0 | 1 | -1)

                                              Settings

                                              Member Visibility

                                              Theme

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_datastore_tests.InterfacDatastoreTest.html b/interfaces/interface_datastore_tests.InterfacDatastoreTest.html index 71806424..fb52ee2d 100644 --- a/interfaces/interface_datastore_tests.InterfacDatastoreTest.html +++ b/interfaces/interface_datastore_tests.InterfacDatastoreTest.html @@ -1,3 +1,3 @@ -InterfacDatastoreTest | IPFS Stores

                                              Interface InterfacDatastoreTest<D>

                                              interface InterfacDatastoreTest {
                                                  setup(): D | Promise<D>;
                                                  teardown(store): void | Promise<void>;
                                              }

                                              Type Parameters

                                              Methods

                                              setup +InterfacDatastoreTest | IPFS Stores

                                              Interface InterfacDatastoreTest<D>

                                              interface InterfacDatastoreTest {
                                                  setup(): D | Promise<D>;
                                                  teardown(store): void | Promise<void>;
                                              }

                                              Type Parameters

                                              Methods

                                              setup teardown -

                                              Methods

                                              setup

                                              teardown

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file +

                                              Methods

                                              setup

                                              teardown

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_store.AbortOptions.html b/interfaces/interface_store.AbortOptions.html index ecb7437f..fab46e56 100644 --- a/interfaces/interface_store.AbortOptions.html +++ b/interfaces/interface_store.AbortOptions.html @@ -1,3 +1,3 @@ AbortOptions | IPFS Stores

                                              Interface AbortOptions

                                              Options for async operations.

                                              -
                                              interface AbortOptions {
                                                  signal?: AbortSignal;
                                              }

                                              Properties

                                              signal? -

                                              Properties

                                              Optional signal

                                              signal?: AbortSignal

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file +
                                              interface AbortOptions {
                                                  signal?: AbortSignal;
                                              }

                                              Properties

                                              signal? +

                                              Properties

                                              Optional signal

                                              signal?: AbortSignal

                                              Settings

                                              Member Visibility

                                              Theme

                                              On This Page

                                              Generated using TypeDoc

                                              \ No newline at end of file diff --git a/interfaces/interface_store.Store.html b/interfaces/interface_store.Store.html index 3086bc0a..6b0baa87 100644 --- a/interfaces/interface_store.Store.html +++ b/interfaces/interface_store.Store.html @@ -1,4 +1,4 @@ -Store | IPFS Stores

                                              Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

                                              interface Store {
                                                  delete(key, options?): Await<void>;
                                                  deleteMany(source, options?): AwaitIterable<Key>;
                                                  get(key, options?): Await<Value>;
                                                  getMany(source, options?): AwaitIterable<Pair>;
                                                  has(key, options?): Await<boolean>;
                                                  put(key, val, options?): Await<Key>;
                                                  putMany(source, options?): AwaitIterable<Key>;
                                              }

                                              Type Parameters

                                              • Key

                                              • Value

                                              • Pair

                                              • HasOptionsExtension = {}

                                              • PutOptionsExtension = {}

                                              • PutManyOptionsExtension = {}

                                              • GetOptionsExtension = {}

                                              • GetManyOptionsExtension = {}

                                              • DeleteOptionsExtension = {}

                                              • DeleteManyOptionsExtension = {}

                                              Hierarchy

                                              • Store

                                                Methods

                                                delete +Store | IPFS Stores

                                                Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

                                                interface Store {
                                                    delete(key, options?): Await<void>;
                                                    deleteMany(source, options?): AwaitIterable<Key>;
                                                    get(key, options?): Await<Value>;
                                                    getMany(source, options?): AwaitIterable<Pair>;
                                                    has(key, options?): Await<boolean>;
                                                    put(key, val, options?): Await<Key>;
                                                    putMany(source, options?): AwaitIterable<Key>;
                                                }

                                                Type Parameters

                                                • Key

                                                • Value

                                                • Pair

                                                • HasOptionsExtension = {}

                                                • PutOptionsExtension = {}

                                                • PutManyOptionsExtension = {}

                                                • GetOptionsExtension = {}

                                                • GetManyOptionsExtension = {}

                                                • DeleteOptionsExtension = {}

                                                • DeleteManyOptionsExtension = {}

                                                Hierarchy

                                                • Store

                                                  Methods

                                                  delete deleteMany get getMany @@ -8,22 +8,22 @@

                                                  Methods

                                                  delete

                                                  • delete(key, options?): Await<void>

                                                  • Remove the record for the passed key

                                                    Parameters

                                                    • key: Key
                                                    • Optional options: AbortOptions & DeleteOptionsExtension

                                                    Returns Await<void>

                                                    Example

                                                    await store.delete(new Key('awesome'))
                                                    console.log('deleted awesome content :(')
                                                    -

                                                  deleteMany

                                                  deleteMany

                                                  • deleteMany(source, options?): AwaitIterable<Key>

                                                  • Remove values for the passed keys

                                                    Parameters

                                                    Returns AwaitIterable<Key>

                                                    Example

                                                    const source = [new Key('awesome')]

                                                    for await (const key of store.deleteMany(source)) {
                                                      console.log(`deleted content with key ${key}`)
                                                    }
                                                    -

                                                  get

                                                  • get(key, options?): Await<Value>

                                                  • Retrieve the value stored under the given key

                                                    +

                                                  get

                                                  • get(key, options?): Await<Value>

                                                  • Retrieve the value stored under the given key

                                                    Parameters

                                                    • key: Key
                                                    • Optional options: AbortOptions & GetOptionsExtension

                                                    Returns Await<Value>

                                                    Example

                                                    const value = await store.get(new Key('awesome'))
                                                    console.log('got content: %s', value.toString('utf8'))
                                                    // => got content: datastore
                                                    -

                                                  getMany

                                                  getMany

                                                  • getMany(source, options?): AwaitIterable<Pair>

                                                  • Retrieve values for the passed keys

                                                    Parameters

                                                    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"
                                                    }
                                                    -

                                                  has

                                                  • has(key, options?): Await<boolean>

                                                  • Check for the existence of a value for the passed key

                                                    +

                                                  has

                                                  • has(key, options?): Await<boolean>

                                                  • Check for the existence of a value for the passed key

                                                    Parameters

                                                    • key: Key
                                                    • Optional options: AbortOptions & HasOptionsExtension

                                                    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')
                                                    }
                                                    -

                                                  put

                                                  • put(key, val, options?): Await<Key>

                                                  • Store the passed value under the passed key

                                                    +

                                                  put

                                                  • put(key, val, options?): Await<Key>

                                                  • Store the passed value under the passed key

                                                    Parameters

                                                    • key: Key
                                                    • val: Value
                                                    • Optional options: AbortOptions & PutOptionsExtension

                                                    Returns Await<Key>

                                                    Example

                                                    await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
                                                    -

                                                  putMany

                                                  putMany

                                                  • putMany(source, options?): AwaitIterable<Key>

                                                  • Store the given key/value pairs

                                                    Parameters

                                                    Returns AwaitIterable<Key>

                                                    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}`)
                                                    }
                                                    -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_core.base.html b/modules/blockstore_core.base.html index 05878375..8e77e6cc 100644 --- a/modules/blockstore_core.base.html +++ b/modules/blockstore_core.base.html @@ -1,2 +1,2 @@ -base | IPFS Stores

                                                  Module base

                                                  Index

                                                  Classes

                                                  BaseBlockstore +base | IPFS Stores

                                                  Module base

                                                  Index

                                                  Classes

                                                  BaseBlockstore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_core.black_hole.html b/modules/blockstore_core.black_hole.html index 509adf18..13b7dc8b 100644 --- a/modules/blockstore_core.black_hole.html +++ b/modules/blockstore_core.black_hole.html @@ -1,2 +1,2 @@ -black-hole | IPFS Stores

                                                  Module black-hole

                                                  Index

                                                  Classes

                                                  BlackHoleBlockstore +black-hole | IPFS Stores

                                                  Module black-hole

                                                  Index

                                                  Classes

                                                  BlackHoleBlockstore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_core.errors.html b/modules/blockstore_core.errors.html index a75ffac3..6a7dff8e 100644 --- a/modules/blockstore_core.errors.html +++ b/modules/blockstore_core.errors.html @@ -1,4 +1,4 @@ -errors | IPFS Stores

                                                  Module errors

                                                  Index

                                                  Functions

                                                  abortedError +errors | IPFS Stores

                                                  Module errors

                                                  Index

                                                  Functions

                                                  abortedError closeFailedError deleteFailedError getFailedError diff --git a/modules/blockstore_core.html b/modules/blockstore_core.html index 2b672ac7..4c972b50 100644 --- a/modules/blockstore_core.html +++ b/modules/blockstore_core.html @@ -1,4 +1,4 @@ -blockstore-core | IPFS Stores

                                                  Module blockstore-core

                                                  blockstore-core

                                                  ipfs.tech +blockstore-core | IPFS Stores

                                                  Module blockstore-core

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -29,4 +29,4 @@ index memory tiered -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_core.index.html b/modules/blockstore_core.index.html index 9f2efa2b..2799b20e 100644 --- a/modules/blockstore_core.index.html +++ b/modules/blockstore_core.index.html @@ -18,7 +18,7 @@

                                                  Example: TieredBlockstore

                                                  A tiered blockstore wraps one or more block

                                                  Writes are invoked on all wrapped blockstores.

                                                  import { TieredBlockstore } from 'blockstore-core/tiered'

                                                  const store = new TieredBlockstore([
                                                    store1,
                                                    store2,
                                                    // ...etc
                                                  ])
                                                  -

                                                  References

                                                  BaseBlockstore +

                                                  References

                                                  BaseBlockstore BlackHoleBlockstore MemoryBlockstore TieredBlockstore diff --git a/modules/blockstore_core.memory.html b/modules/blockstore_core.memory.html index b0672dff..6a7240ec 100644 --- a/modules/blockstore_core.memory.html +++ b/modules/blockstore_core.memory.html @@ -1,2 +1,2 @@ -memory | IPFS Stores

                                                  Module memory

                                                  Index

                                                  Classes

                                                  MemoryBlockstore +memory | IPFS Stores

                                                  Module memory

                                                  Index

                                                  Classes

                                                  MemoryBlockstore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_core.tiered.html b/modules/blockstore_core.tiered.html index 6950f499..62b826d0 100644 --- a/modules/blockstore_core.tiered.html +++ b/modules/blockstore_core.tiered.html @@ -1,2 +1,2 @@ -tiered | IPFS Stores

                                                  Module tiered

                                                  Index

                                                  Classes

                                                  TieredBlockstore +tiered | IPFS Stores

                                                  Module tiered

                                                  Index

                                                  Classes

                                                  TieredBlockstore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_fs.html b/modules/blockstore_fs.html index 454f6067..66844c3f 100644 --- a/modules/blockstore_fs.html +++ b/modules/blockstore_fs.html @@ -1,4 +1,4 @@ -blockstore-fs | IPFS Stores

                                                  Module blockstore-fs

                                                  blockstore-fs

                                                  ipfs.tech +blockstore-fs | IPFS Stores

                                                  Module blockstore-fs

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -22,4 +22,4 @@

                                                  Index

                                                  Modules

                                                  index sharding -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_fs.index.html b/modules/blockstore_fs.index.html index 66abb002..09f7c2d8 100644 --- a/modules/blockstore_fs.index.html +++ b/modules/blockstore_fs.index.html @@ -1,6 +1,6 @@ index | IPFS Stores

                                                  Module index

                                                  A Blockstore implementation that stores blocks in the local filesystem.

                                                  Example

                                                  import { FsBlockstore } from 'blockstore-fs'

                                                  const store = new FsBlockstore('path/to/store')
                                                  -

                                                  Index

                                                  Classes

                                                  FsBlockstore +

                                                  Index

                                                  Classes

                                                  FsBlockstore

                                                  Interfaces

                                                  FsBlockstoreInit

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_fs.sharding.html b/modules/blockstore_fs.sharding.html index e0ce6eb2..ba1fd4e4 100644 --- a/modules/blockstore_fs.sharding.html +++ b/modules/blockstore_fs.sharding.html @@ -1,4 +1,4 @@ -sharding | IPFS Stores

                                                  Module sharding

                                                  Index

                                                  Classes

                                                  FlatDirectory +sharding | IPFS Stores

                                                  Module sharding

                                                  Index

                                                  Classes

                                                  FlatDirectory NextToLast

                                                  Interfaces

                                                  FlatDirectoryInit NextToLastInit diff --git a/modules/blockstore_idb.html b/modules/blockstore_idb.html index cfe07179..c53ae135 100644 --- a/modules/blockstore_idb.html +++ b/modules/blockstore_idb.html @@ -1,7 +1,7 @@ blockstore-idb | IPFS Stores

                                                  Module blockstore-idb

                                                  A Blockstore implementation for browsers that stores blocks in IndexedDB.

                                                  Example

                                                  import { IDBBlockstore } from 'blockstore-idb'

                                                  const store = new IDBBlockstore('path/to/store')
                                                  -

                                                  blockstore-idb

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -31,4 +31,4 @@

                                                  Index

                                                  Classes

                                                  IDBBlockstore

                                                  Interfaces

                                                  IDBBlockstoreInit -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_level.html b/modules/blockstore_level.html index d6f1eead..1c3d237f 100644 --- a/modules/blockstore_level.html +++ b/modules/blockstore_level.html @@ -2,7 +2,7 @@

                                                  N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.

                                                  Example

                                                  import { LevelBlockstore } from 'blockstore-level'

                                                  const store = new LevelBlockstore('path/to/store')
                                                  -

                                                  blockstore-level

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -33,4 +33,4 @@

                                                  Index

                                                  Classes

                                                  LevelBlockstore

                                                  Interfaces

                                                  LevelBlockstoreInit -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/blockstore_s3.html b/modules/blockstore_s3.html index e8db84f5..19e29cf2 100644 --- a/modules/blockstore_s3.html +++ b/modules/blockstore_s3.html @@ -4,7 +4,7 @@

                                                  Example

                                                  Using with Helia

                                                  See [examples/helia](./examples/helia) for a full example of how to use Helia with an S3 backed blockstore.
                                                  -

                                                  blockstore-s3

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -38,4 +38,4 @@

                                                  Example

                                                  Using
                                                  Index
                                                  Classes
                                                  S3Blockstore
 
                                                  Interfaces
                                                  S3BlockstoreInit
 ShardingStrategy
-

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.base.html b/modules/datastore_core.base.html index 0598c193..c058d6fe 100644 --- a/modules/datastore_core.base.html +++ b/modules/datastore_core.base.html @@ -1,2 +1,2 @@ -base | IPFS Stores

                                                  Module base

                                                  Index

                                                  Classes

                                                  BaseDatastore +base | IPFS Stores

                                                  Module base

                                                  Index

                                                  Classes

                                                  BaseDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.black_hole.html b/modules/datastore_core.black_hole.html index db5ce59c..15dce05d 100644 --- a/modules/datastore_core.black_hole.html +++ b/modules/datastore_core.black_hole.html @@ -1,2 +1,2 @@ -black-hole | IPFS Stores

                                                  Module black-hole

                                                  Index

                                                  Classes

                                                  BlackHoleDatastore +black-hole | IPFS Stores

                                                  Module black-hole

                                                  Index

                                                  Classes

                                                  BlackHoleDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.errors.html b/modules/datastore_core.errors.html index 35a33776..a56ce5b8 100644 --- a/modules/datastore_core.errors.html +++ b/modules/datastore_core.errors.html @@ -1,4 +1,4 @@ -errors | IPFS Stores

                                                  Module errors

                                                  Index

                                                  Functions

                                                  abortedError +errors | IPFS Stores

                                                  Module errors

                                                  Index

                                                  Functions

                                                  abortedError dbDeleteFailedError dbOpenFailedError dbReadFailedError diff --git a/modules/datastore_core.html b/modules/datastore_core.html index 27c6787d..099b8c25 100644 --- a/modules/datastore_core.html +++ b/modules/datastore_core.html @@ -1,4 +1,4 @@ -datastore-core | IPFS Stores

                                                  Module datastore-core

                                                  datastore-core

                                                  ipfs.tech +datastore-core | IPFS Stores

                                                  Module datastore-core

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -34,4 +34,4 @@ shard sharding tiered -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.index.html b/modules/datastore_core.index.html index fe2d31a3..7d51bb7e 100644 --- a/modules/datastore_core.index.html +++ b/modules/datastore_core.index.html @@ -16,7 +16,7 @@

                                                  Example: Wrapping Stores

                                                  import { BlackHoleDatastore } from 'datastore-core/black-hole'

                                                  const store = new BlackHoleDatastore()
                                                  -

                                                  References

                                                  BaseDatastore +

                                                  References

                                                  BaseDatastore Errors KeyTransformDatastore MemoryDatastore diff --git a/modules/datastore_core.keytransform.html b/modules/datastore_core.keytransform.html index cfd8d669..b798e413 100644 --- a/modules/datastore_core.keytransform.html +++ b/modules/datastore_core.keytransform.html @@ -1,2 +1,2 @@ -keytransform | IPFS Stores

                                                  Module keytransform

                                                  Index

                                                  Classes

                                                  KeyTransformDatastore +keytransform | IPFS Stores

                                                  Module keytransform

                                                  Index

                                                  Classes

                                                  KeyTransformDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.memory.html b/modules/datastore_core.memory.html index dd4b191d..151edcd4 100644 --- a/modules/datastore_core.memory.html +++ b/modules/datastore_core.memory.html @@ -1,2 +1,2 @@ -memory | IPFS Stores

                                                  Module memory

                                                  Index

                                                  Classes

                                                  MemoryDatastore +memory | IPFS Stores

                                                  Module memory

                                                  Index

                                                  Classes

                                                  MemoryDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.mount.html b/modules/datastore_core.mount.html index 753c35c0..1ba38a59 100644 --- a/modules/datastore_core.mount.html +++ b/modules/datastore_core.mount.html @@ -1,2 +1,2 @@ -mount | IPFS Stores

                                                  Module mount

                                                  Index

                                                  Classes

                                                  MountDatastore +mount | IPFS Stores

                                                  Module mount

                                                  Index

                                                  Classes

                                                  MountDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.namespace.html b/modules/datastore_core.namespace.html index 71165292..207c4507 100644 --- a/modules/datastore_core.namespace.html +++ b/modules/datastore_core.namespace.html @@ -1,2 +1,2 @@ -namespace | IPFS Stores

                                                  Module namespace

                                                  Index

                                                  Classes

                                                  NamespaceDatastore +namespace | IPFS Stores

                                                  Module namespace

                                                  Index

                                                  Classes

                                                  NamespaceDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.shard.html b/modules/datastore_core.shard.html index 0c4259c5..e1e0591c 100644 --- a/modules/datastore_core.shard.html +++ b/modules/datastore_core.shard.html @@ -1,4 +1,4 @@ -shard | IPFS Stores

                                                  Module shard

                                                  Index

                                                  Classes

                                                  NextToLast +shard | IPFS Stores

                                                  Module shard

                                                  Index

                                                  Classes

                                                  NextToLast Prefix ShardBase Suffix diff --git a/modules/datastore_core.sharding.html b/modules/datastore_core.sharding.html index 3452dfb0..af9cf9e3 100644 --- a/modules/datastore_core.sharding.html +++ b/modules/datastore_core.sharding.html @@ -1,2 +1,2 @@ -sharding | IPFS Stores

                                                  Module sharding

                                                  Index

                                                  Classes

                                                  ShardingDatastore +sharding | IPFS Stores

                                                  Module sharding

                                                  Index

                                                  Classes

                                                  ShardingDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_core.tiered.html b/modules/datastore_core.tiered.html index b53bf79e..0d289fc7 100644 --- a/modules/datastore_core.tiered.html +++ b/modules/datastore_core.tiered.html @@ -1,2 +1,2 @@ -tiered | IPFS Stores

                                                  Module tiered

                                                  Index

                                                  Classes

                                                  TieredDatastore +tiered | IPFS Stores

                                                  Module tiered

                                                  Index

                                                  Classes

                                                  TieredDatastore

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_fs.html b/modules/datastore_fs.html index db7d3288..6b647fdd 100644 --- a/modules/datastore_fs.html +++ b/modules/datastore_fs.html @@ -1,7 +1,7 @@ datastore-fs | IPFS Stores

                                                  Module datastore-fs

                                                  A Datastore implementation with a file system backend.

                                                  Example

                                                  import { FsDatastore } from 'datastore-fs'

                                                  const store = new FsDatastore('path/to/store')
                                                  -

                                                  datastore-fs

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -28,4 +28,4 @@

                                                  Index

                                                  Classes

                                                  FsDatastore

                                                  Interfaces

                                                  FsDatastoreInit -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_idb.html b/modules/datastore_idb.html index dcb365bc..585cbdc1 100644 --- a/modules/datastore_idb.html +++ b/modules/datastore_idb.html @@ -1,7 +1,7 @@ datastore-idb | IPFS Stores

                                                  Module datastore-idb

                                                  A Datastore implementation for browsers that stores data in IndexedDB.

                                                  Example

                                                  import { IDBDatastore } from 'datastore-idb'

                                                  const store = new IDBDatastore('path/to/store')
                                                  -

                                                  datastore-idb

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -31,4 +31,4 @@

                                                  Index

                                                  Classes

                                                  IDBDatastore

                                                  Interfaces

                                                  IDBDatastoreInit -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_level.html b/modules/datastore_level.html index cbccc5fb..d758c3a6 100644 --- a/modules/datastore_level.html +++ b/modules/datastore_level.html @@ -8,7 +8,7 @@ 
                                                  import leveljs from 'level-js'
                                                  import browserStore = new LevelDatastore(
                                                    new Level('my/db/name', {
                                                      prefix: 'IDBWrapper-'
                                                    })
                                                  })

                                                  More information: https://github.com/Level/level-js/blob/master/UPGRADING.md#new-database-prefix

                                                  -

                                                  datastore-level

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -44,4 +44,4 @@

                                                  Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

                                                  Index

                                                  Classes

                                                  LevelDatastore -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/datastore_s3.html b/modules/datastore_s3.html index 68c71da5..b5ad9b07 100644 --- a/modules/datastore_s3.html +++ b/modules/datastore_s3.html @@ -4,7 +4,7 @@

                                                  Example

                                                  Using with Helia

                                                  See [examples/helia](./examples/helia) for a full example of how to use Helia with an S3 backed datastore.
                                                  -

                                                  datastore-s3

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -37,4 +37,4 @@

                                                  Example

                                                  Using

                                                  Index

                                                  Classes

                                                  S3Datastore

                                                  Interfaces

                                                  S3DatastoreInit -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_blockstore.html b/modules/interface_blockstore.html index f5d72b44..81b0ceb2 100644 --- a/modules/interface_blockstore.html +++ b/modules/interface_blockstore.html @@ -7,7 +7,7 @@
                                                • Memory: blockstore-core/memory
                                                • S3: blockstore-s3
                                                  • -

                                                  interface-blockstore

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -40,4 +40,4 @@

                                                  Index

                                                  Interfaces

                                                  Blockstore Pair -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_blockstore_tests.html b/modules/interface_blockstore_tests.html index daaadbb0..b080c29e 100644 --- a/modules/interface_blockstore_tests.html +++ b/modules/interface_blockstore_tests.html @@ -1,7 +1,7 @@ interface-blockstore-tests | IPFS Stores

                                                  Module interface-blockstore-tests

                                                  A test suite that ensures a given implementation implements the Blockstore interface properly.

                                                  Example

                                                  const MyBlockstore from './path/to/my-blockstore')
                                                  const suite from 'interface-blockstore-tests')

                                                  describe('MyBlockstore', () => {
                                                    describe('interface-blockstore compliance tests', () => {
                                                      suite({
                                                        setup () {
                                                          return new MyBlockstore()
                                                        },
                                                        teardown () {}
                                                      })
                                                    })
                                                  })
                                                  -

                                                  interface-blockstore-tests

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -28,4 +28,4 @@

                                                  Index

                                                  Interfaces

                                                  InterfaceBlockstoreTest

                                                  Functions

                                                  interfaceBlockstoreTests -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_datastore.html b/modules/interface_datastore.html index a5e7371e..b0a4b619 100644 --- a/modules/interface_datastore.html +++ b/modules/interface_datastore.html @@ -1,4 +1,4 @@ -interface-datastore | IPFS Stores

                                                  Module interface-datastore

                                                  interface-datastore

                                                  ipfs.tech +interface-datastore | IPFS Stores

                                                  Module interface-datastore

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -25,4 +25,4 @@

                                                  Index

                                                  Modules

                                                  index key -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_datastore.index.html b/modules/interface_datastore.index.html index 811022fb..cb139c1a 100644 --- a/modules/interface_datastore.index.html +++ b/modules/interface_datastore.index.html @@ -38,7 +38,7 @@
                                                • new Key('/Comedy/MontyPython/Sketch:CheeseShop')
                                                • new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')
                                                  • -

                                                  References

                                                  Key +

                                                  References

                                                  Key

                                                  Interfaces

                                                  Batch Datastore KeyQuery diff --git a/modules/interface_datastore.key.html b/modules/interface_datastore.key.html index c90e2bed..773293ff 100644 --- a/modules/interface_datastore.key.html +++ b/modules/interface_datastore.key.html @@ -1,2 +1,2 @@ -key | IPFS Stores

                                                  Module key

                                                  Index

                                                  Classes

                                                  Key +key | IPFS Stores

                                                  Module key

                                                  Index

                                                  Classes

                                                  Key

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_datastore_tests.html b/modules/interface_datastore_tests.html index 6208d64b..8f9d4865 100644 --- a/modules/interface_datastore_tests.html +++ b/modules/interface_datastore_tests.html @@ -1,7 +1,7 @@ interface-datastore-tests | IPFS Stores

                                                  Module interface-datastore-tests

                                                  A test suite that ensures a given implementation implements the Datastore interface properly.

                                                  Example

                                                  const MyDatastore from './path/to/my-datastore')
                                                  const suite from 'interface-datastore-tests')

                                                  describe('MyDatastore', () => {
                                                    describe('interface-datastore compliance tests', () => {
                                                      suite({
                                                        setup () {
                                                          return new MyDatastore()
                                                        },
                                                        teardown () {}
                                                      })
                                                    })
                                                  })
                                                  -

                                                  interface-datastore-tests

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -28,4 +28,4 @@

                                                  Index

                                                  Interfaces

                                                  InterfacDatastoreTest

                                                  Functions

                                                  interfaceDatastoreTests -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/modules/interface_store.html b/modules/interface_store.html index 6d663be4..d2365170 100644 --- a/modules/interface_store.html +++ b/modules/interface_store.html @@ -1,5 +1,5 @@ interface-store | IPFS Stores

                                                  Module interface-store

                                                  An abstraction of the Datastore/Blockstore codebases.

                                                  -

                                                  interface-store

                                                  ipfs.tech +

                                                  ipfs.tech Discuss codecov CI

                                                  @@ -26,4 +26,4 @@ Store

                                                  Type Aliases

                                                  Await AwaitIterable -

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  On This Page

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/types/interface_store.Await.html b/types/interface_store.Await.html index 942a4bd0..7acb6fbe 100644 --- a/types/interface_store.Await.html +++ b/types/interface_store.Await.html @@ -1,2 +1,2 @@ Await | IPFS Stores

                                                  Type alias Await<T>

                                                  Await<T>: Promise<T> | T

                                                  A value or a promise of a value

                                                  -

                                                  Type Parameters

                                                  • T

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Type Parameters

                                                  • T

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/types/interface_store.AwaitIterable.html b/types/interface_store.AwaitIterable.html index f86a8dcf..f45b9de7 100644 --- a/types/interface_store.AwaitIterable.html +++ b/types/interface_store.AwaitIterable.html @@ -1,2 +1,2 @@ AwaitIterable | IPFS Stores

                                                  Type alias AwaitIterable<T>

                                                  AwaitIterable<T>: Iterable<T> | AsyncIterable<T>

                                                  An iterable or async iterable of values

                                                  -

                                                  Type Parameters

                                                  • T

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +

                                                  Type Parameters

                                                  • T

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/variables/blockstore_core.index.Errors.html b/variables/blockstore_core.index.Errors.html index bdb242eb..5856f248 100644 --- a/variables/blockstore_core.index.Errors.html +++ b/variables/blockstore_core.index.Errors.html @@ -1 +1 @@ -Errors | IPFS Stores

                                                  Variable ErrorsConst

                                                  Errors: {
                                                      abortedError(err?): Error;
                                                      closeFailedError(err?): Error;
                                                      deleteFailedError(err?): Error;
                                                      getFailedError(err?): Error;
                                                      hasFailedError(err?): Error;
                                                      notFoundError(err?): Error;
                                                      openFailedError(err?): Error;
                                                      putFailedError(err?): Error;
                                                  } = ...

                                                  Type declaration

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +Errors | IPFS Stores

                                                  Variable ErrorsConst

                                                  Errors: {
                                                      abortedError(err?): Error;
                                                      closeFailedError(err?): Error;
                                                      deleteFailedError(err?): Error;
                                                      getFailedError(err?): Error;
                                                      hasFailedError(err?): Error;
                                                      notFoundError(err?): Error;
                                                      openFailedError(err?): Error;
                                                      putFailedError(err?): Error;
                                                  } = ...

                                                  Type declaration

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/variables/datastore_core.shard.PREFIX-1.html b/variables/datastore_core.shard.PREFIX-1.html index ce550804..95f4ebd2 100644 --- a/variables/datastore_core.shard.PREFIX-1.html +++ b/variables/datastore_core.shard.PREFIX-1.html @@ -1 +1 @@ -PREFIX | IPFS Stores

                                                  Variable PREFIXConst

                                                  PREFIX: "/repo/flatfs/shard/" = '/repo/flatfs/shard/'

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +PREFIX | IPFS Stores

                                                  Variable PREFIXConst

                                                  PREFIX: "/repo/flatfs/shard/" = '/repo/flatfs/shard/'

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file diff --git a/variables/datastore_core.shard.SHARDING_FN.html b/variables/datastore_core.shard.SHARDING_FN.html index 5f5641f1..cffb600f 100644 --- a/variables/datastore_core.shard.SHARDING_FN.html +++ b/variables/datastore_core.shard.SHARDING_FN.html @@ -1 +1 @@ -SHARDING_FN | IPFS Stores

                                                  Variable SHARDING_FNConst

                                                  SHARDING_FN: "SHARDING" = 'SHARDING'

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file +SHARDING_FN | IPFS Stores

                                                  Variable SHARDING_FNConst

                                                  SHARDING_FN: "SHARDING" = 'SHARDING'

                                                  Settings

                                                  Member Visibility

                                                  Theme

                                                  Generated using TypeDoc

                                                  \ No newline at end of file