From a48a2a3417447c6e918d21976b6943b397271f6d Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Fri, 13 Sep 2024 14:44:03 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- .../blockstore_core.base.BaseBlockstore.html | 18 ++++---- ...e_core.black_hole.BlackHoleBlockstore.html | 18 ++++---- ...tore_core.identity.IdentityBlockstore.html | 20 ++++---- ...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 +++++++++---------- classes/interface_store.AbortError.html | 4 +- classes/interface_store.CloseFailedError.html | 4 +- .../interface_store.DeleteFailedError.html | 4 +- classes/interface_store.GetFailedError.html | 4 +- classes/interface_store.HasFailedError.html | 4 +- classes/interface_store.NotFoundError.html | 4 +- classes/interface_store.OpenFailedError.html | 4 +- classes/interface_store.PutFailedError.html | 4 +- .../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.identity.html | 2 +- modules/blockstore_core.index.html | 2 +- modules/blockstore_core.memory.html | 2 +- modules/blockstore_core.tiered.html | 2 +- modules/blockstore_fs.index.html | 2 +- modules/blockstore_fs.sharding.html | 2 +- modules/datastore_core.base.html | 2 +- modules/datastore_core.black_hole.html | 2 +- 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/interface_datastore.index.html | 2 +- modules/interface_datastore.key.html | 2 +- types/interface_store.Await.html | 2 +- types/interface_store.AwaitIterable.html | 2 +- variables/datastore_core.shard.PREFIX-1.html | 2 +- .../datastore_core.shard.SHARDING_FN.html | 2 +- 92 files changed, 391 insertions(+), 391 deletions(-) diff --git a/classes/blockstore_core.base.BaseBlockstore.html b/classes/blockstore_core.base.BaseBlockstore.html index 26e3800c..95a72559 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 (view full)

Implements

Constructors

constructor +BaseBlockstore | IPFS Stores

Class BaseBlockstore

Hierarchy (view full)

Implements

Constructors

constructor

Methods

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

Constructors

constructor

Methods

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
    -

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

constructordeletedeleteManygetgetAllgetManyhasputputMany
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordeletedeleteManygetgetAllgetManyhasputputMany
\ 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 df5fea26..aaa04e74 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 (view full)

Constructors

constructor +BlackHoleBlockstore | IPFS Stores

Class BlackHoleBlockstore

Hierarchy (view full)

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

constructordeletedeleteManygetgetAllgetManyhasputputMany
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordeletedeleteManygetgetAllgetManyhasputputMany
\ No newline at end of file diff --git a/classes/blockstore_core.identity.IdentityBlockstore.html b/classes/blockstore_core.identity.IdentityBlockstore.html index 8c04a35d..cd0800d9 100644 --- a/classes/blockstore_core.identity.IdentityBlockstore.html +++ b/classes/blockstore_core.identity.IdentityBlockstore.html @@ -1,4 +1,4 @@ -IdentityBlockstore | IPFS Stores

Class IdentityBlockstore

Hierarchy (view full)

Constructors

constructor +IdentityBlockstore | IPFS Stores

Class IdentityBlockstore

Hierarchy (view full)

Constructors

constructor

Properties

child?

Methods

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

Constructors

constructor

Properties

Private Optional Readonly child

child?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Methods

                  delete

                  • delete(key): Await<void>

                  • Remove the record for the passed key

                    +

                  Constructors

                  constructor

                  Properties

                  Private Optional Readonly child

                  child?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                  Type declaration

                    Type declaration

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Methods

                                  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

                                  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

                                  constructorchilddeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructorchilddeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_core.memory.MemoryBlockstore.html b/classes/blockstore_core.memory.MemoryBlockstore.html index 7551e30f..4e8f8b18 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 (view full)

                                  Constructors

                                  constructor +MemoryBlockstore | IPFS Stores

                                  Class MemoryBlockstore

                                  Hierarchy (view full)

                                  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

                                  constructordatadeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructordatadeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_core.tiered.TieredBlockstore.html b/classes/blockstore_core.tiered.TieredBlockstore.html index c7a4879c..9c3a8881 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 (view full)

                                  Constructors

                                  constructor +

                                  Hierarchy (view full)

                                  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

                                  constructorstoresdeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructorstoresdeletedeleteManygetgetAllgetManyhasputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_fs.index.FsBlockstore.html b/classes/blockstore_fs.index.FsBlockstore.html index 415df5fa..f72e75cd 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

                                  constructorcreateIfMissingdeleteManyConcurrencyerrorIfExistsgetManyConcurrencypathputManyConcurrencyshardingStrategyclosedeletedeleteManygetgetAllgetManyhasopenputputMany
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructorcreateIfMissingdeleteManyConcurrencyerrorIfExistsgetManyConcurrencypathputManyConcurrencyshardingStrategyclosedeletedeleteManygetgetAllgetManyhasopenputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_fs.sharding.FlatDirectory.html b/classes/blockstore_fs.sharding.FlatDirectory.html index fc5a8d78..164ed0d9 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

                                  constructorbaseextensiondecodeencode
                                  \ 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

                                  constructorbaseextensiondecodeencode
                                  \ No newline at end of file diff --git a/classes/blockstore_fs.sharding.NextToLast.html b/classes/blockstore_fs.sharding.NextToLast.html index 38ef1ecd..59a6b2b3 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

                                  constructorbaseextensionprefixLengthdecodeencode
                                  \ 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

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

                                  Class IDBBlockstore

                                  Hierarchy (view full)

                                  Constructors

                                  constructor +IDBBlockstore | IPFS Stores

                                  Class IDBBlockstore

                                  Hierarchy (view full)

                                  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

                                  constructorbasedblocationversion#decode#encodeclosedeletedeleteManydestroygetgetAllgetManyhasopenputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_level.LevelBlockstore.html b/classes/blockstore_level.LevelBlockstore.html index 1a47056e..687e9e78 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 (view full)

                                  Constructors

                                  constructor +

                                  Hierarchy (view full)

                                  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

                                  constructorbasedbopts#decode#encode#queryclosedeletedeleteManygetgetAllgetManyhasopenputputMany
                                  \ No newline at end of file diff --git a/classes/blockstore_s3.S3Blockstore.html b/classes/blockstore_s3.S3Blockstore.html index 620b6ac2..de745e02 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 (view full)

                                  Constructors

                                  constructor +

                                  Hierarchy (view full)

                                  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

                                  constructorbucketcreateIfMissings3shardingStrategydeletedeleteManygetgetAllgetManyhasopenputputMany
                                  \ No newline at end of file diff --git a/classes/datastore_core.base.BaseDatastore.html b/classes/datastore_core.base.BaseDatastore.html index 0ae38170..c3c90748 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 (view full)

                                  Implements

                                  Constructors

                                  constructor +BaseDatastore | IPFS Stores

                                  Class BaseDatastore

                                  Hierarchy (view full)

                                  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

                                  constructor_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructor_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                  \ 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 eefc98b5..f82900eb 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 (view full)

                                  Constructors

                                  constructor +BlackHoleDatastore | IPFS Stores

                                  Class BlackHoleDatastore

                                  Hierarchy (view full)

                                  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

                                  constructor_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                  \ No newline at end of file +

                                  Settings

                                  Member Visibility

                                  Theme

                                  On This Page

                                  constructor_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                  \ No newline at end of file diff --git a/classes/datastore_core.keytransform.KeyTransformDatastore.html b/classes/datastore_core.keytransform.KeyTransformDatastore.html index f822a186..785ccd83 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 (view full)

                                  Constructors

                                  constructor +

                                  Hierarchy (view full)

                                  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

                                                                          constructorchildtransform_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file +

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          constructorchildtransform_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.memory.MemoryDatastore.html b/classes/datastore_core.memory.MemoryDatastore.html index 4c76c5ac..721ac35b 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 (view full)

                                                                          Constructors

                                                                          constructor +MemoryDatastore | IPFS Stores

                                                                          Class MemoryDatastore

                                                                          Hierarchy (view full)

                                                                          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

                                                                          constructordata_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file +

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          constructordata_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.mount.MountDatastore.html b/classes/datastore_core.mount.MountDatastore.html index a57c5bb2..569fc861 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 (view full)

                                                                          Constructors

                                                                          constructor +

                                                                          Hierarchy (view full)

                                                                          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

                                                                          constructormounts_all_allKeys_lookupbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file +

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          constructormounts_all_allKeys_lookupbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.namespace.NamespaceDatastore.html b/classes/datastore_core.namespace.NamespaceDatastore.html index 9e68b1c4..94ea7d4f 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 (view full)

                                                                          Constructors

                                                                          constructor +

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          constructor

                                                                          Properties

                                                                          iChild iKey transform @@ -19,36 +19,36 @@ putMany query queryKeys -

                                                                          Constructors

                                                                          constructor

                                                                          Properties

                                                                          Private Readonly iChild

                                                                          iChild: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              Private Readonly iKey

                                                                                              iKey: Key

                                                                                              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 iChild

                                                                                              iChild: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  Private Readonly iKey

                                                                                                                  iKey: Key

                                                                                                                  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

                                                                                                                  constructoriChildiKeytransform_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructoriChildiKeytransform_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.shard.NextToLast.html b/classes/datastore_core.shard.NextToLast.html index 0cdf5b9c..60575588 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +NextToLast | IPFS Stores

                                                                                                                  Class NextToLast

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ 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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.shard.Prefix.html b/classes/datastore_core.shard.Prefix.html index 07eab5c0..c855de30 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +Prefix | IPFS Stores

                                                                                                                  Class Prefix

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ 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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.shard.ShardBase.html b/classes/datastore_core.shard.ShardBase.html index 9fbd27e0..7cf5f2a0 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 (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  constructor +ShardBase | IPFS Stores

                                                                                                                  Class ShardBase

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ 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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.shard.Suffix.html b/classes/datastore_core.shard.Suffix.html index 0b6b36ba..1077dec2 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +Suffix | IPFS Stores

                                                                                                                  Class Suffix

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ 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

                                                                                                                  constructor_paddingnameparamfuntoString
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.sharding.ShardingDatastore.html b/classes/datastore_core.sharding.ShardingDatastore.html index 4057a64f..26c589d9 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructorchildshard_all_allKeys_convertKey_invertKeybatchdeletedeleteManygetgetManyhasopenputputManyqueryqueryKeyscreate
                                                                                                                  \ No newline at end of file +

                                                                                                                  Static create

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorchildshard_all_allKeys_convertKey_invertKeybatchdeletedeleteManygetgetManyhasopenputputManyqueryqueryKeyscreate
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.tiered.TieredDatastore.html b/classes/datastore_core.tiered.TieredDatastore.html index 4e2e7e43..6b96cfbf 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructorstores_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorstores_all_allKeysbatchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_fs.FsDatastore.html b/classes/datastore_fs.FsDatastore.html index 6ee75e2c..5f1125d0 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructordblocationversion#queryIt_all_allKeysbatchclosedeletedeleteManydestroygetgetManyhasopenputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_level.LevelDatastore.html b/classes/datastore_level.LevelDatastore.html index 55308218..fa9cbc94 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (view full)

                                                                                                                  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

                                                                                                                  constructordbopts_all_allKeys_querybatchclosedeletedeleteManygetgetManyhasopenputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructordbopts_all_allKeys_querybatchclosedeletedeleteManygetgetManyhasopenputputManyqueryqueryKeys
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_s3.S3Datastore.html b/classes/datastore_s3.S3Datastore.html index cc048bb7..eb5556a4 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 (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (view full)

                                                                                                                  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 355b1827..1bdea0ee 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

                                                                                                                  constructor_buf[toStringTag]baseNamespacechildcleanconcatinstanceisAncestorOfisDecendantOfisTopLevellesslistnamenamespacesparentpathreversetoStringtypeuint8ArrayasKeyrandomwithNamespaces
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructor_buf[toStringTag]baseNamespacechildcleanconcatinstanceisAncestorOfisDecendantOfisTopLevellesslistnamenamespacesparentpathreversetoStringtypeuint8ArrayasKeyrandomwithNamespaces
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.AbortError.html b/classes/interface_store.AbortError.html index 5b96a5c1..43fbfc5c 100644 --- a/classes/interface_store.AbortError.html +++ b/classes/interface_store.AbortError.html @@ -1,4 +1,4 @@ -AbortError | IPFS Stores

                                                                                                                  Class AbortError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +AbortError | IPFS Stores

                                                                                                                  Class AbortError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = AbortError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = AbortError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_ABORTED'

                                                                                                                  Static name

                                                                                                                  name: string = 'AbortError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = AbortError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = AbortError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_ABORTED'

                                                                                                                  Static name

                                                                                                                  name: string = 'AbortError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.CloseFailedError.html b/classes/interface_store.CloseFailedError.html index a010468a..6dc05045 100644 --- a/classes/interface_store.CloseFailedError.html +++ b/classes/interface_store.CloseFailedError.html @@ -1,4 +1,4 @@ -CloseFailedError | IPFS Stores

                                                                                                                  Class CloseFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +CloseFailedError | IPFS Stores

                                                                                                                  Class CloseFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = CloseFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = CloseFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_CLOSE_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'CloseFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = CloseFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = CloseFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_CLOSE_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'CloseFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.DeleteFailedError.html b/classes/interface_store.DeleteFailedError.html index 81f184f4..4f8af8ee 100644 --- a/classes/interface_store.DeleteFailedError.html +++ b/classes/interface_store.DeleteFailedError.html @@ -1,4 +1,4 @@ -DeleteFailedError | IPFS Stores

                                                                                                                  Class DeleteFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +DeleteFailedError | IPFS Stores

                                                                                                                  Class DeleteFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = DeleteFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = DeleteFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_DELETE_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'DeleteFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = DeleteFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = DeleteFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_DELETE_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'DeleteFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.GetFailedError.html b/classes/interface_store.GetFailedError.html index 4c979042..1c6d4c3e 100644 --- a/classes/interface_store.GetFailedError.html +++ b/classes/interface_store.GetFailedError.html @@ -1,4 +1,4 @@ -GetFailedError | IPFS Stores

                                                                                                                  Class GetFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +GetFailedError | IPFS Stores

                                                                                                                  Class GetFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = GetFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = GetFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_GET_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'GetFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = GetFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = GetFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_GET_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'GetFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.HasFailedError.html b/classes/interface_store.HasFailedError.html index 66e3128e..6232426e 100644 --- a/classes/interface_store.HasFailedError.html +++ b/classes/interface_store.HasFailedError.html @@ -1,4 +1,4 @@ -HasFailedError | IPFS Stores

                                                                                                                  Class HasFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +HasFailedError | IPFS Stores

                                                                                                                  Class HasFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = HasFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = HasFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_HAS_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'HasFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = HasFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = HasFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_HAS_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'HasFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.NotFoundError.html b/classes/interface_store.NotFoundError.html index c1cd16c5..22474965 100644 --- a/classes/interface_store.NotFoundError.html +++ b/classes/interface_store.NotFoundError.html @@ -1,4 +1,4 @@ -NotFoundError | IPFS Stores

                                                                                                                  Class NotFoundError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +NotFoundError | IPFS Stores

                                                                                                                  Class NotFoundError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = NotFoundError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = NotFoundError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_NOT_FOUND'

                                                                                                                  Static name

                                                                                                                  name: string = 'NotFoundError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = NotFoundError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = NotFoundError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_NOT_FOUND'

                                                                                                                  Static name

                                                                                                                  name: string = 'NotFoundError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.OpenFailedError.html b/classes/interface_store.OpenFailedError.html index a6fb189e..8f1e0aed 100644 --- a/classes/interface_store.OpenFailedError.html +++ b/classes/interface_store.OpenFailedError.html @@ -1,4 +1,4 @@ -OpenFailedError | IPFS Stores

                                                                                                                  Class OpenFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +OpenFailedError | IPFS Stores

                                                                                                                  Class OpenFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = OpenFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = OpenFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_OPEN_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'OpenFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = OpenFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = OpenFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_OPEN_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'OpenFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.PutFailedError.html b/classes/interface_store.PutFailedError.html index eb60e2c5..a62a91e2 100644 --- a/classes/interface_store.PutFailedError.html +++ b/classes/interface_store.PutFailedError.html @@ -1,4 +1,4 @@ -PutFailedError | IPFS Stores

                                                                                                                  Class PutFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +PutFailedError | IPFS Stores

                                                                                                                  Class PutFailedError

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  cause? code message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

                                                                                                                  Methods

                                                                                                                  captureStackTrace -

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = PutFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = PutFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_PUT_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'PutFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  Optional cause

                                                                                                                  cause?: unknown

                                                                                                                  code

                                                                                                                  code: string = PutFailedError.code

                                                                                                                  message

                                                                                                                  message: string

                                                                                                                  name

                                                                                                                  name: string = PutFailedError.name

                                                                                                                  Optional stack

                                                                                                                  stack?: string

                                                                                                                  Static code

                                                                                                                  code: string = 'ERR_PUT_FAILED'

                                                                                                                  Static name

                                                                                                                  name: string = 'PutFailedError'

                                                                                                                  Static Optional prepareStackTrace

                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any

                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  See

                                                                                                                  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                                                  Static stackTraceLimit

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  Static captureStackTrace

                                                                                                                  • captureStackTrace(targetObject, constructorOpt?): void

                                                                                                                  • Create .stack property on a target object

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  constructorcausecodemessagenamestackcodenameprepareStackTracestackTraceLimitcaptureStackTrace
                                                                                                                  \ No newline at end of file diff --git a/functions/datastore_core.shard.parseShardFun.html b/functions/datastore_core.shard.parseShardFun.html index db87e5a6..8c86d4dc 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

                                                                                                                  \ No newline at end of file +

                                                                                                                  Parameters

                                                                                                                  Returns Shard

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  \ No newline at end of file diff --git a/functions/datastore_core.shard.readShardFun.html b/functions/datastore_core.shard.readShardFun.html index d8068bef..4648df8d 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

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

                                                                                                                  Function readShardFun

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  \ No newline at end of file diff --git a/functions/interface_blockstore_tests.interfaceBlockstoreTests.html b/functions/interface_blockstore_tests.interfaceBlockstoreTests.html index 1bb2e4ba..40cab56c 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

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

                                                                                                                  Function interfaceBlockstoreTests

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  \ No newline at end of file diff --git a/functions/interface_datastore_tests.interfaceDatastoreTests.html b/functions/interface_datastore_tests.interfaceDatastoreTests.html index 7ddbcb3a..579ec666 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

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

                                                                                                                  Function interfaceDatastoreTests

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.index.FsBlockstoreInit.html b/interfaces/blockstore_fs.index.FsBlockstoreInit.html index 54f01308..2425e7d7 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

                                                                                                                  createIfMissingdeleteManyConcurrencyerrorIfExistsextensiongetManyConcurrencyputManyConcurrencyshardingStrategy
                                                                                                                  \ 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

                                                                                                                  createIfMissingdeleteManyConcurrencyerrorIfExistsextensiongetManyConcurrencyputManyConcurrencyshardingStrategy
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html b/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html index 21bdcc1a..82d0ac2e 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

                                                                                                                  baseextensionprefixLength
                                                                                                                  \ 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

                                                                                                                  baseextensionprefixLength
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.NextToLastInit.html b/interfaces/blockstore_fs.sharding.NextToLastInit.html index 16ecbec3..919a524a 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

                                                                                                                  baseextensionprefixLength
                                                                                                                  \ 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

                                                                                                                  baseextensionprefixLength
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.ShardingStrategy.html b/interfaces/blockstore_fs.sharding.ShardingStrategy.html index 488106bf..ac65ac10 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

                                                                                                                  extensiondecodeencode
                                                                                                                  \ 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

                                                                                                                  extensiondecodeencode
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_idb.IDBBlockstoreInit.html b/interfaces/blockstore_idb.IDBBlockstoreInit.html index 17330258..7b92ab05 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

                                                                                                                  baseprefixversion
                                                                                                                  \ 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

                                                                                                                  baseprefixversion
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_level.LevelBlockstoreInit.html b/interfaces/blockstore_level.LevelBlockstoreInit.html index 0441e1c3..d7141e32 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;
                                                                                                                      multithreading?: boolean;
                                                                                                                      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;
                                                                                                                      multithreading?: boolean;
                                                                                                                      passive?: boolean;
                                                                                                                      prefix?: string;
                                                                                                                      valueEncoding?: string | PartialEncoding<Uint8Array, Uint8Array>;
                                                                                                                      version?: string | number;
                                                                                                                      writeBufferSize?: number;
                                                                                                                  }

                                                                                                                  Hierarchy

                                                                                                                  Properties

                                                                                                                  base? blockRestartInterval? blockSize? cacheSize? @@ -16,7 +16,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 17da3687..ccbb9bf2 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

                                                                                                                  createIfMissingshardingStrategy
                                                                                                                  \ 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

                                                                                                                  createIfMissingshardingStrategy
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_s3.ShardingStrategy.html b/interfaces/blockstore_s3.ShardingStrategy.html index 17904388..52dc401c 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

                                                                                                                  extensiondecodeencode
                                                                                                                  \ No newline at end of file +

                                                                                                                  Properties

                                                                                                                  extension

                                                                                                                  extension: string

                                                                                                                  Methods

                                                                                                                  decode

                                                                                                                  encode

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  extensiondecodeencode
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_core.index.KeyTransform.html b/interfaces/datastore_core.index.KeyTransform.html index 3600c2fb..300f8dc3 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

                                                                                                                  convertinvert
                                                                                                                  \ No newline at end of file +

                                                                                                                  Methods

                                                                                                                  convert

                                                                                                                  invert

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  convertinvert
                                                                                                                  \ 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 f0411a31..0ea61596 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

                                                                                                                  _paddingnameparamfuntoString
                                                                                                                  \ 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

                                                                                                                  _paddingnameparamfuntoString
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_fs.FsDatastoreInit.html b/interfaces/datastore_fs.FsDatastoreInit.html index 2a34b6d2..3c66bbec 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

                                                                                                                  createIfMissingdeleteManyConcurrencyerrorIfExistsextensiongetManyConcurrencyputManyConcurrency
                                                                                                                  \ 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

                                                                                                                  createIfMissingdeleteManyConcurrencyerrorIfExistsextensiongetManyConcurrencyputManyConcurrency
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_idb.IDBDatastoreInit.html b/interfaces/datastore_idb.IDBDatastoreInit.html index a90471f6..0631f23a 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

                                                                                                                  prefixversion
                                                                                                                  \ No newline at end of file +

                                                                                                                  Optional version

                                                                                                                  version?: number

                                                                                                                  The database version (default: 1)

                                                                                                                  +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  prefixversion
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_s3.S3DatastoreInit.html b/interfaces/datastore_s3.S3DatastoreInit.html index 24de3611..49888328 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

                                                                                                                  createIfMissingpath
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  Theme

                                                                                                                  On This Page

                                                                                                                  createIfMissingpath
                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface_blockstore.Blockstore.html b/interfaces/interface_blockstore.Blockstore.html index e17e9130..deb67f66 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<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension> {
                                                                                                                      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 (view full)

                                                                                                                  Implemented by

                                                                                                                    Methods

                                                                                                                    delete +Blockstore | IPFS Stores

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

                                                                                                                    interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension> {
                                                                                                                        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 (view full)

                                                                                                                    Implemented by

                                                                                                                      Methods

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

                                                                                                                      getAll

                                                                                                                      getMany

                                                                                                                      getMany

                                                                                                                      has

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      On This Page

                                                                                                                      batchdeletedeleteManygetgetManyhasputputManyqueryqueryKeys
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQuery.html b/interfaces/interface_datastore.index.KeyQuery.html index 8d2ee3b0..cddea416 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

                                                                                                                      filterslimitoffsetordersprefix
                                                                                                                      \ 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

                                                                                                                      filterslimitoffsetordersprefix
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryFilter.html b/interfaces/interface_datastore.index.KeyQueryFilter.html index 5501d863..f661212e 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

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

                                                                                                                      Interface KeyQueryFilter

                                                                                                                      interface KeyQueryFilter ((item) => boolean)

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryOrder.html b/interfaces/interface_datastore.index.KeyQueryOrder.html index aaf8cb34..079ec158 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) => -1 | 0 | 1)

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

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

                                                                                                                      Interface KeyQueryOrder

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

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Pair.html b/interfaces/interface_datastore.index.Pair.html index 4798f676..b45a2a35 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

                                                                                                                      keyvalue
                                                                                                                      \ No newline at end of file +

                                                                                                                      Properties

                                                                                                                      key

                                                                                                                      key: Key

                                                                                                                      value

                                                                                                                      value: Uint8Array

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      On This Page

                                                                                                                      keyvalue
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Query.html b/interfaces/interface_datastore.index.Query.html index 28feb7df..810c99d5 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

                                                                                                                      filterslimitoffsetordersprefix
                                                                                                                      \ 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

                                                                                                                      filterslimitoffsetordersprefix
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryFilter.html b/interfaces/interface_datastore.index.QueryFilter.html index 911731ed..ef72b419 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

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

                                                                                                                      Interface QueryFilter

                                                                                                                      interface QueryFilter ((item) => boolean)

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryOrder.html b/interfaces/interface_datastore.index.QueryOrder.html index 53b8113a..8723ef94 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) => -1 | 0 | 1)

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

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

                                                                                                                      Interface QueryOrder

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

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore_tests.InterfacDatastoreTest.html b/interfaces/interface_datastore_tests.InterfacDatastoreTest.html index 38866b50..ea5ad166 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<D> {
                                                                                                                          setup(): D | Promise<D>;
                                                                                                                          teardown(store): void | Promise<void>;
                                                                                                                      }

                                                                                                                      Type Parameters

                                                                                                                      Methods

                                                                                                                      setup +InterfacDatastoreTest | IPFS Stores

                                                                                                                      Interface InterfacDatastoreTest<D>

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

                                                                                                                      Type Parameters

                                                                                                                      Methods

                                                                                                                      setup teardown -

                                                                                                                      Methods

                                                                                                                      setup

                                                                                                                      teardown

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      On This Page

                                                                                                                      setupteardown
                                                                                                                      \ No newline at end of file +

                                                                                                                      Methods

                                                                                                                      setup

                                                                                                                      teardown

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      On This Page

                                                                                                                      setupteardown
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_store.AbortOptions.html b/interfaces/interface_store.AbortOptions.html index b0acf92b..c53b7e77 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

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

                                                                                                                      Properties

                                                                                                                      signal? +

                                                                                                                      Properties

                                                                                                                      Optional signal

                                                                                                                      signal?: AbortSignal

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      Theme

                                                                                                                      On This Page

                                                                                                                      signal
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_store.Store.html b/interfaces/interface_store.Store.html index b8bf1ab9..480f816f 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<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension> {
                                                                                                                          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<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension> {
                                                                                                                            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

                                                                                                                          deleteMany

                                                                                                                          deleteMany

                                                                                                                          get

                                                                                                                          get

                                                                                                                          getMany

                                                                                                                          getMany

                                                                                                                          has

                                                                                                                          has

                                                                                                                          put

                                                                                                                          put

                                                                                                                          putMany

                                                                                                                          putMany

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          On This Page

                                                                                                                          deletedeleteManygetgetManyhasputputMany
                                                                                                                          \ No newline at end of file +

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          On This Page

                                                                                                                          deletedeleteManygetgetManyhasputputMany
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.base.html b/modules/blockstore_core.base.html index 5e60bd34..0df15565 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

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.black_hole.html b/modules/blockstore_core.black_hole.html index cda2f983..a32f4dce 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

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.identity.html b/modules/blockstore_core.identity.html index 81bbe0d0..0aee26d2 100644 --- a/modules/blockstore_core.identity.html +++ b/modules/blockstore_core.identity.html @@ -1,2 +1,2 @@ -identity | IPFS Stores

                                                                                                                          Module identity

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          IdentityBlockstore +identity | IPFS Stores

                                                                                                                          Module identity

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          IdentityBlockstore

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.index.html b/modules/blockstore_core.index.html index ba61b6c3..1a59e056 100644 --- a/modules/blockstore_core.index.html +++ b/modules/blockstore_core.index.html @@ -21,7 +21,7 @@

                                                                                                                          Example: TieredBlockstore

                                                                                                                          A tiered blockstore wraps one or more block

                                                                                                                          Example: IdentityBlockstore

                                                                                                                          An identity blockstore is one that deals exclusively in Identity CIDs - this is a special CID with the codec 0x00 where the multihash digest is the data that makes up the block.

                                                                                                                          import { IdentityBlockstore } from 'blockstore-core/identity'
                                                                                                                          import { CID } from 'multiformats/cid'

                                                                                                                          const blockstore = new IdentityBlockstore()

                                                                                                                          blockstore.has(CID.parse('QmFoo')) // false

                                                                                                                          blockstore.has(CID.parse('bafkqac3imvwgy3zao5xxe3de')) // true
                                                                                                                          -

                                                                                                                          References

                                                                                                                          BaseBlockstore +

                                                                                                                          References

                                                                                                                          BaseBlockstore BlackHoleBlockstore MemoryBlockstore TieredBlockstore diff --git a/modules/blockstore_core.memory.html b/modules/blockstore_core.memory.html index 7858698c..8b527bc2 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

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.tiered.html b/modules/blockstore_core.tiered.html index f3f64230..3f92e0c3 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

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_fs.index.html b/modules/blockstore_fs.index.html index 71f3a648..d9c0208c 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

                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_fs.sharding.html b/modules/blockstore_fs.sharding.html index 6e28c212..e4667d5c 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/datastore_core.base.html b/modules/datastore_core.base.html index e1db3c6c..f1e79ac4 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.black_hole.html b/modules/datastore_core.black_hole.html index 68b5c59a..0cb65bbc 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.index.html b/modules/datastore_core.index.html index 95d64e2e..48ff9bd1 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 KeyTransformDatastore MemoryDatastore MountDatastore diff --git a/modules/datastore_core.keytransform.html b/modules/datastore_core.keytransform.html index ea38caa5..f736f4c8 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.memory.html b/modules/datastore_core.memory.html index fee50506..2fb5bebc 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.mount.html b/modules/datastore_core.mount.html index 0f99d85a..cdcdfcb0 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.namespace.html b/modules/datastore_core.namespace.html index 2e5c3036..ffbda52b 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.shard.html b/modules/datastore_core.shard.html index fafc23f9..245cfddb 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 360292ea..95cb4e37 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

                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.tiered.html b/modules/datastore_core.tiered.html index 79869d94..7afe3b2e 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

                                                                                                                          \ No newline at end of file diff --git a/modules/interface_datastore.index.html b/modules/interface_datastore.index.html index a6108f6c..57f055ed 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 791898fc..d8aac82b 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

                                                                                                                          \ No newline at end of file diff --git a/types/interface_store.Await.html b/types/interface_store.Await.html index 9a29fac8..c5902b0e 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

                                                                                                                          \ No newline at end of file +

                                                                                                                          Type Parameters

                                                                                                                          • T

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          \ No newline at end of file diff --git a/types/interface_store.AwaitIterable.html b/types/interface_store.AwaitIterable.html index cc0a72af..be47ed35 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

                                                                                                                          \ No newline at end of file +

                                                                                                                          Type Parameters

                                                                                                                          • T

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          \ 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 69c55f56..1a97c18b 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

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

                                                                                                                          Variable PREFIXConst

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

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          \ 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 593fda54..fdc20f4c 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

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

                                                                                                                          Variable SHARDING_FNConst

                                                                                                                          SHARDING_FN: "SHARDING" = 'SHARDING'

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          \ No newline at end of file