diff --git a/classes/blockstore_core.base.BaseBlockstore.html b/classes/blockstore_core.base.BaseBlockstore.html index 14719319..4690e968 100644 --- a/classes/blockstore_core.base.BaseBlockstore.html +++ b/classes/blockstore_core.base.BaseBlockstore.html @@ -1,4 +1,4 @@ -BaseBlockstore | IPFS Stores

Hierarchy (view full)

Implements

Constructors

constructor +BaseBlockstore | IPFS Stores

Hierarchy (view full)

Implements

Constructors

Methods

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

Constructors

Methods

  • Remove the record for the passed key

    Parameters

    Returns Await<void>

    Example

    await store.delete(new Key('awesome'))
    console.log('deleted awesome content :(')
    -
  • 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
    -
  • 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')
    }
    -
\ No newline at end of file +
\ 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 4a40a1f6..207cc23b 100644 --- a/classes/blockstore_core.black_hole.BlackHoleBlockstore.html +++ b/classes/blockstore_core.black_hole.BlackHoleBlockstore.html @@ -1,4 +1,4 @@ -BlackHoleBlockstore | IPFS Stores

Hierarchy (view full)

Constructors

constructor +BlackHoleBlockstore | IPFS Stores

Hierarchy (view full)

Constructors

Methods

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

Constructors

Methods

  • 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')
    }
    -
\ No newline at end of file +
\ No newline at end of file diff --git a/classes/blockstore_core.identity.IdentityBlockstore.html b/classes/blockstore_core.identity.IdentityBlockstore.html index 3a65a367..2a0bdf2c 100644 --- a/classes/blockstore_core.identity.IdentityBlockstore.html +++ b/classes/blockstore_core.identity.IdentityBlockstore.html @@ -1,4 +1,4 @@ -IdentityBlockstore | IPFS Stores

Hierarchy (view full)

Constructors

constructor +IdentityBlockstore | IPFS Stores

Hierarchy (view full)

Constructors

Properties

Methods

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

Constructors

Properties

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

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Methods

                  • Remove the record for the passed key

                    +

                  Constructors

                  Properties

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

                  Type declaration

                    Type declaration

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Methods

                                  • Remove the record for the passed key

                                    Parameters

                                    Returns Await<void>

                                    Example

                                    await store.delete(new Key('awesome'))
                                    console.log('deleted awesome content :(')
                                    -
                                  • 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')
                                    }
                                    -
                                  \ No newline at end of file +
                                  \ No newline at end of file diff --git a/classes/blockstore_core.memory.MemoryBlockstore.html b/classes/blockstore_core.memory.MemoryBlockstore.html index 9f438509..f81ec8fe 100644 --- a/classes/blockstore_core.memory.MemoryBlockstore.html +++ b/classes/blockstore_core.memory.MemoryBlockstore.html @@ -1,4 +1,4 @@ -MemoryBlockstore | IPFS Stores

                                  Hierarchy (view full)

                                  Constructors

                                  constructor +MemoryBlockstore | IPFS Stores

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

                                  Methods

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

                                  Constructors

                                  Properties

                                  data: Map<string, Uint8Array>

                                  Methods

                                  • Remove the record for the passed key

                                    +

                                  Constructors

                                  Properties

                                  data: Map<string, Uint8Array>

                                  Methods

                                  • Remove the record for the passed key

                                    Parameters

                                    Returns Promise<void>

                                    Example

                                    await store.delete(new Key('awesome'))
                                    console.log('deleted awesome content :(')
                                    -
                                  • 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
                                    -
                                  • 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')
                                    }
                                    -
                                  \ No newline at end of file +
                                  \ No newline at end of file diff --git a/classes/blockstore_core.tiered.TieredBlockstore.html b/classes/blockstore_core.tiered.TieredBlockstore.html index 5c91d037..41293ff9 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

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

                                  Methods

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

                                  Constructors

                                  Properties

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

                                  Methods

                                  • Remove the record for the passed key

                                    +

                                  Constructors

                                  Properties

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

                                  Methods

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

                                  A blockstore backed by the file system

                                  -

                                  Implements

                                  Constructors

                                  Implements

                                  Constructors

                                  Properties

                                  Constructors

                                  Properties

                                  createIfMissing: boolean
                                  deleteManyConcurrency: number
                                  errorIfExists: boolean
                                  getManyConcurrency: number
                                  path: string
                                  putManyConcurrency: number
                                  shardingStrategy: ShardingStrategy

                                  Methods

                                  • Remove the record for the passed key

                                    +

                                  Constructors

                                  Properties

                                  createIfMissing: boolean
                                  deleteManyConcurrency: number
                                  errorIfExists: boolean
                                  getManyConcurrency: number
                                  path: string
                                  putManyConcurrency: number
                                  shardingStrategy: ShardingStrategy

                                  Methods

                                  • Remove the record for the passed key

                                    Parameters

                                    Returns Promise<void>

                                    Example

                                    await store.delete(new Key('awesome'))
                                    console.log('deleted awesome content :(')
                                    -
                                  • 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}`)
                                    }
                                    -
                                  • 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
                                    -
                                  • Retrieve all cid/block pairs from the blockstore as an unordered iterable

                                    +
                                  • 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[...]
                                    }
                                    -
                                  • 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"
                                    }
                                    -
                                  • 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}`)
                                    }
                                    -
                                  \ No newline at end of file +
                                  \ No newline at end of file diff --git a/classes/blockstore_fs.sharding.FlatDirectory.html b/classes/blockstore_fs.sharding.FlatDirectory.html index 1ff0a4c6..6c0e5066 100644 --- a/classes/blockstore_fs.sharding.FlatDirectory.html +++ b/classes/blockstore_fs.sharding.FlatDirectory.html @@ -1,8 +1,8 @@ FlatDirectory | IPFS Stores

                                  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

                                  Implements

                                  Constructors

                                  Properties

                                  Methods

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  extension: string

                                  Methods

                                  • Parameters

                                    Returns {
                                        dir: string;
                                        file: string;
                                    }

                                    • dir: string
                                    • file: string
                                  \ No newline at end of file +

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  extension: string

                                  Methods

                                  \ No newline at end of file diff --git a/classes/blockstore_fs.sharding.NextToLast.html b/classes/blockstore_fs.sharding.NextToLast.html index cf355dd6..0af64f9c 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

                                  Implements

                                  Constructors

                                  Properties

                                  Methods

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  extension: string
                                  prefixLength: number

                                  Methods

                                  • Parameters

                                    Returns {
                                        dir: string;
                                        file: string;
                                    }

                                    • dir: string
                                    • file: string
                                  \ No newline at end of file +

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  extension: string
                                  prefixLength: number

                                  Methods

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

                                  Hierarchy (view full)

                                  Constructors

                                  constructor +IDBBlockstore | IPFS Stores

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

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

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  db?: IDBPDatabase<unknown>
                                  location: string
                                  version: number

                                  Methods

                                  • Remove the record for the passed key

                                    +

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  db?: IDBPDatabase<unknown>
                                  location: string
                                  version: number

                                  Methods

                                  • 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"
                                    }
                                  • 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')
                                    }
                                    -
                                  • 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}`)
                                    }
                                  \ No newline at end of file diff --git a/classes/blockstore_level.LevelBlockstore.html b/classes/blockstore_level.LevelBlockstore.html index bde3a5f9..5e0cded4 100644 --- a/classes/blockstore_level.LevelBlockstore.html +++ b/classes/blockstore_level.LevelBlockstore.html @@ -1,5 +1,5 @@ LevelBlockstore | IPFS Stores

                                  A blockstore backed by leveldb

                                  -

                                  Hierarchy (view full)

                                  Constructors

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

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

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  db: Level<string, Uint8Array>

                                  Methods

                                  • Parameters

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

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

                                  • Remove the record for the passed key

                                    +

                                  Constructors

                                  Properties

                                  base: MultibaseCodec<string>
                                  db: Level<string, Uint8Array>

                                  Methods

                                  • Parameters

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

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

                                  • 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"
                                    }
                                  • 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}`)
                                    }
                                  \ No newline at end of file diff --git a/classes/blockstore_s3.S3Blockstore.html b/classes/blockstore_s3.S3Blockstore.html index 6812ea44..d932b84c 100644 --- a/classes/blockstore_s3.S3Blockstore.html +++ b/classes/blockstore_s3.S3Blockstore.html @@ -1,5 +1,5 @@ S3Blockstore | IPFS Stores

                                  A blockstore backed by AWS S3

                                  -

                                  Hierarchy (view full)

                                  Constructors

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

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

                                  Constructors

                                  Properties

                                  bucket: string
                                  createIfMissing: boolean
                                  s3: S3
                                  shardingStrategy: ShardingStrategy

                                  Methods

                                  • Remove values for the passed keys

                                    +

                                  Constructors

                                  Properties

                                  bucket: string
                                  createIfMissing: boolean
                                  s3: S3
                                  shardingStrategy: ShardingStrategy

                                  Methods

                                  • 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"
                                    }
                                  • 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}`)
                                    }
                                  \ No newline at end of file diff --git a/classes/datastore_core.base.BaseDatastore.html b/classes/datastore_core.base.BaseDatastore.html index 084490ef..2c86b466 100644 --- a/classes/datastore_core.base.BaseDatastore.html +++ b/classes/datastore_core.base.BaseDatastore.html @@ -1,4 +1,4 @@ -BaseDatastore | IPFS Stores

                                  Hierarchy (view full)

                                  Implements

                                  Constructors

                                  constructor +BaseDatastore | IPFS Stores

                                  Hierarchy (view full)

                                  Implements

                                  Constructors

                                  Methods

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

                                  Constructors

                                  Methods

                                  • 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>

                                  • 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')
                                    -
                                  • Remove the record for the passed key

                                    Parameters

                                    Returns Await<void>

                                    Example

                                    await store.delete(new Key('awesome'))
                                    console.log('deleted awesome content :(')
                                    -
                                  • 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
                                    -
                                  • 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')
                                    }
                                    -
                                  \ No newline at end of file +
                                  \ 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 804f64c1..51fd17d8 100644 --- a/classes/datastore_core.black_hole.BlackHoleDatastore.html +++ b/classes/datastore_core.black_hole.BlackHoleDatastore.html @@ -1,4 +1,4 @@ -BlackHoleDatastore | IPFS Stores

                                  Hierarchy (view full)

                                  Constructors

                                  constructor +BlackHoleDatastore | IPFS Stores

                                  Hierarchy (view full)

                                  Constructors

                                  Methods

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

                                  Constructors

                                  Methods

                                  • 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')
                                    -
                                  • Remove the record for the passed key

                                    Parameters

                                    Returns Await<void>

                                    Example

                                    await store.delete(new Key('awesome'))
                                    console.log('deleted awesome content :(')
                                    -
                                  • 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')
                                    }
                                    -
                                  • 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]) }])
                                     
                                    -
                                  \ No newline at end of file +
                                  \ No newline at end of file diff --git a/classes/datastore_core.keytransform.KeyTransformDatastore.html b/classes/datastore_core.keytransform.KeyTransformDatastore.html index d123e02c..27ca6a17 100644 --- a/classes/datastore_core.keytransform.KeyTransformDatastore.html +++ b/classes/datastore_core.keytransform.KeyTransformDatastore.html @@ -1,7 +1,7 @@ KeyTransformDatastore | IPFS Stores

                                  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

                                  Hierarchy (view full)

                                  Constructors

                                  Properties

                                  Methods

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

                                  Constructors

                                  Properties

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

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          Type declaration

                                            Type declaration

                                              Type declaration

                                                Type declaration

                                                  Type declaration

                                                    Type declaration

                                                      transform: KeyTransform

                                                      Methods

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

                                                        +

                                                      Constructors

                                                      Properties

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

                                                      Type declaration

                                                        Type declaration

                                                          Type declaration

                                                            Type declaration

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          transform: KeyTransform

                                                                          Methods

                                                                          • 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')
                                                                            -
                                                                          • 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}`)
                                                                            }
                                                                            -
                                                                          • 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"
                                                                            }
                                                                            -
                                                                          • 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')
                                                                            }
                                                                            -
                                                                          • 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 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)
                                                                            -
                                                                          • 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)
                                                                            -
                                                                          \ No newline at end of file +
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.memory.MemoryDatastore.html b/classes/datastore_core.memory.MemoryDatastore.html index 897851ec..c3104deb 100644 --- a/classes/datastore_core.memory.MemoryDatastore.html +++ b/classes/datastore_core.memory.MemoryDatastore.html @@ -1,4 +1,4 @@ -MemoryDatastore | IPFS Stores

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          constructor +MemoryDatastore | IPFS Stores

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          Properties

                                                                          Methods

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

                                                                          Constructors

                                                                          Properties

                                                                          data: Map<string, Uint8Array>

                                                                          Methods

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

                                                                            +

                                                                          Constructors

                                                                          Properties

                                                                          data: Map<string, Uint8Array>

                                                                          Methods

                                                                          • 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')
                                                                            -
                                                                          • Remove the record for the passed key

                                                                            Parameters

                                                                            Returns Await<void>

                                                                            Example

                                                                            await store.delete(new Key('awesome'))
                                                                            console.log('deleted awesome content :(')
                                                                            -
                                                                          • 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
                                                                            -
                                                                          • 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')
                                                                            }
                                                                            -
                                                                          \ No newline at end of file +
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.mount.MountDatastore.html b/classes/datastore_core.mount.MountDatastore.html index e68cd255..b4778c89 100644 --- a/classes/datastore_core.mount.MountDatastore.html +++ b/classes/datastore_core.mount.MountDatastore.html @@ -1,6 +1,6 @@ MountDatastore | IPFS Stores

                                                                          A datastore that can combine multiple stores inside various key prefixes

                                                                          -

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          Properties

                                                                          Methods

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

                                                                          Constructors

                                                                          Properties

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

                                                                          Type declaration

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

                                                                          Methods

                                                                          • Lookup the matching datastore for the given key

                                                                            -

                                                                            Parameters

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

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

                                                                            +

                                                                          Constructors

                                                                          Properties

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

                                                                          Type declaration

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

                                                                          Methods

                                                                          • Lookup the matching datastore for the given key

                                                                            +

                                                                            Parameters

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

                                                                          • 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')
                                                                            -
                                                                          • 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')
                                                                            }
                                                                            -
                                                                          • 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)
                                                                            -
                                                                          • 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)
                                                                            -
                                                                          \ No newline at end of file +
                                                                          \ No newline at end of file diff --git a/classes/datastore_core.namespace.NamespaceDatastore.html b/classes/datastore_core.namespace.NamespaceDatastore.html index b419c7a8..adc7390b 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

                                                                          Hierarchy (view full)

                                                                          Constructors

                                                                          Properties

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

                                                                          Constructors

                                                                          Properties

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

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              iKey: Key
                                                                                              transform: KeyTransform

                                                                                              Methods

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

                                                                                                +

                                                                                              Constructors

                                                                                              Properties

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

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  iKey: Key
                                                                                                                  transform: KeyTransform

                                                                                                                  Methods

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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +NextToLast | IPFS Stores

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +Prefix | IPFS Stores

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  constructor +ShardBase | IPFS Stores

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    • s: string

                                                                                                                    Returns string

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    • s: string

                                                                                                                    Returns string

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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  constructor +Suffix | IPFS Stores

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

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

                                                                                                                  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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

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

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  shard: Shard

                                                                                                                  Methods

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

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  shard: Shard

                                                                                                                  Methods

                                                                                                                  • 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')
                                                                                                                    -
                                                                                                                  • 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}`)
                                                                                                                    }
                                                                                                                    -
                                                                                                                  • 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"
                                                                                                                    }
                                                                                                                    -
                                                                                                                  • 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')
                                                                                                                    }
                                                                                                                    -
                                                                                                                  • 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 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)
                                                                                                                    -
                                                                                                                  • 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)
                                                                                                                    -
                                                                                                                  \ No newline at end of file +
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_core.tiered.TieredDatastore.html b/classes/datastore_core.tiered.TieredDatastore.html index 186145f7..bae629e6 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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

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

                                                                                                                  Constructors

                                                                                                                  Properties

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

                                                                                                                  Methods

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

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

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

                                                                                                                  Methods

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

                                                                                                                  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

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  createIfMissing: boolean
                                                                                                                  deleteManyConcurrency: number
                                                                                                                  errorIfExists: boolean
                                                                                                                  extension: string
                                                                                                                  getManyConcurrency: number
                                                                                                                  path: string
                                                                                                                  putManyConcurrency: number

                                                                                                                  Methods

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

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    Returns {
                                                                                                                        dir: string;
                                                                                                                        file: string;
                                                                                                                    }

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

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  createIfMissing: boolean
                                                                                                                  deleteManyConcurrency: number
                                                                                                                  errorIfExists: boolean
                                                                                                                  extension: string
                                                                                                                  getManyConcurrency: number
                                                                                                                  path: string
                                                                                                                  putManyConcurrency: number

                                                                                                                  Methods

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

                                                                                                                    +

                                                                                                                    Parameters

                                                                                                                    Returns {
                                                                                                                        dir: string;
                                                                                                                        file: string;
                                                                                                                    }

                                                                                                                    • dir: string
                                                                                                                    • file: string
                                                                                                                  • 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')
                                                                                                                    -
                                                                                                                  • Remove values for the passed keys

                                                                                                                    +
                                                                                                                  • 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"
                                                                                                                    }
                                                                                                                    -
                                                                                                                  • 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 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)
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_level.LevelDatastore.html b/classes/datastore_level.LevelDatastore.html index 22e51945..66cb89d6 100644 --- a/classes/datastore_level.LevelDatastore.html +++ b/classes/datastore_level.LevelDatastore.html @@ -1,5 +1,5 @@ LevelDatastore | IPFS Stores

                                                                                                                  A datastore backed by leveldb

                                                                                                                  -

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

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

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  db: Level<string, Uint8Array>

                                                                                                                  Methods

                                                                                                                  • Extending classes should override query or implement this method

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  db: Level<string, Uint8Array>

                                                                                                                  Methods

                                                                                                                  • Parameters

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

                                                                                                                    Returns AsyncIterable<Pair>

                                                                                                                  • 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>

                                                                                                                  • Parameters

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

                                                                                                                    Returns AsyncIterable<Pair>

                                                                                                                  • 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')
                                                                                                                    -
                                                                                                                  • 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"
                                                                                                                    }
                                                                                                                  • 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')
                                                                                                                    }
                                                                                                                    -
                                                                                                                  • 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 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)
                                                                                                                    -
                                                                                                                  \ No newline at end of file +
                                                                                                                  \ No newline at end of file diff --git a/classes/datastore_s3.S3Datastore.html b/classes/datastore_s3.S3Datastore.html index 68dba8cb..99a0fb7f 100644 --- a/classes/datastore_s3.S3Datastore.html +++ b/classes/datastore_s3.S3Datastore.html @@ -1,5 +1,5 @@ S3Datastore | IPFS Stores

                                                                                                                  A datastore backed by AWS S3

                                                                                                                  -

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  bucket: string
                                                                                                                  createIfMissing: boolean
                                                                                                                  path?: string
                                                                                                                  s3: S3

                                                                                                                  Methods

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

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    Returns string

                                                                                                                  • Recursively fetches all keys from s3

                                                                                                                    -

                                                                                                                    Parameters

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

                                                                                                                    Returns AsyncIterable<Key>

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

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  bucket: string
                                                                                                                  createIfMissing: boolean
                                                                                                                  path?: string
                                                                                                                  s3: S3

                                                                                                                  Methods

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

                                                                                                                    +

                                                                                                                    Parameters

                                                                                                                    Returns string

                                                                                                                  • Recursively fetches all keys from s3

                                                                                                                    +

                                                                                                                    Parameters

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

                                                                                                                    Returns AsyncIterable<Key>

                                                                                                                  • 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')
                                                                                                                  • 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"
                                                                                                                    }
                                                                                                                  • 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 the datastore.

                                                                                                                    diff --git a/classes/interface_datastore.key.Key.html b/classes/interface_datastore.key.Key.html index 2eab36bf..aac5fa97 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

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Accessors

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Accessors

                                                                                                                  Methods

                                                                                                                  • Returns the "base" namespace of this key.

                                                                                                                    +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Accessors

                                                                                                                  Methods

                                                                                                                  • Returns the "base" namespace of this key.

                                                                                                                    Returns string

                                                                                                                    Example

                                                                                                                    new Key('/Comedy/MontyPython/Actor:JohnCleese').baseNamespace()
                                                                                                                    // => 'Actor:JohnCleese'
                                                                                                                    -
                                                                                                                  • 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')
                                                                                                                    -
                                                                                                                  • Returns an "instance" of this type key (appends value to namespace).

                                                                                                                    +

                                                                                                                  Returns Key

                                                                                                                  Returns boolean

                                                                                                                  Returns string

                                                                                                                  \ No newline at end of file +
                                                                                                                  \ No newline at end of file diff --git a/classes/interface_store.AbortError.html b/classes/interface_store.AbortError.html index b85f14c3..b16a79d5 100644 --- a/classes/interface_store.AbortError.html +++ b/classes/interface_store.AbortError.html @@ -1,4 +1,4 @@ -AbortError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +AbortError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +CloseFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +DeleteFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +GetFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +HasFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +NotFoundError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +OpenFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

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

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  constructor +PutFailedError | IPFS Stores

                                                                                                                  Hierarchy

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  cause?: unknown
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  stack?: string
                                                                                                                  prepareStackTrace?: ((err, stackTraces) => any)

                                                                                                                  Optional override for formatting stack traces

                                                                                                                  Type declaration

                                                                                                                    • (err, stackTraces): any
                                                                                                                    • Parameters

                                                                                                                      Returns any

                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  • Create .stack property on a target object

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • targetObject: object
                                                                                                                    • Optional constructorOpt: Function

                                                                                                                    Returns void

                                                                                                                  \ No newline at end of file +
                                                                                                                  stackTraceLimit: number

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file diff --git a/functions/datastore_core.shard.parseShardFun.html b/functions/datastore_core.shard.parseShardFun.html index ef8d39e0..1adb4782 100644 --- a/functions/datastore_core.shard.parseShardFun.html +++ b/functions/datastore_core.shard.parseShardFun.html @@ -1,2 +1,2 @@ parseShardFun | IPFS Stores
                                                                                                                  • Convert a given string to the matching sharding function

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    • str: string

                                                                                                                    Returns Shard

                                                                                                                  \ No newline at end of file +

                                                                                                                  Parameters

                                                                                                                  Returns Shard

                                                                                                                  \ No newline at end of file diff --git a/functions/datastore_core.shard.readShardFun.html b/functions/datastore_core.shard.readShardFun.html index 1ea58d70..bf498bd3 100644 --- a/functions/datastore_core.shard.readShardFun.html +++ b/functions/datastore_core.shard.readShardFun.html @@ -1 +1 @@ -readShardFun | IPFS Stores
                                                                                                                  \ No newline at end of file +readShardFun | IPFS Stores
                                                                                                                  \ No newline at end of file diff --git a/functions/interface_blockstore_tests.interfaceBlockstoreTests.html b/functions/interface_blockstore_tests.interfaceBlockstoreTests.html index 518e85d1..30711ea3 100644 --- a/functions/interface_blockstore_tests.interfaceBlockstoreTests.html +++ b/functions/interface_blockstore_tests.interfaceBlockstoreTests.html @@ -1 +1 @@ -interfaceBlockstoreTests | IPFS Stores
                                                                                                                  \ No newline at end of file +interfaceBlockstoreTests | IPFS Stores
                                                                                                                  \ No newline at end of file diff --git a/functions/interface_datastore_tests.interfaceDatastoreTests.html b/functions/interface_datastore_tests.interfaceDatastoreTests.html index 0831aee8..aacf8b7a 100644 --- a/functions/interface_datastore_tests.interfaceDatastoreTests.html +++ b/functions/interface_datastore_tests.interfaceDatastoreTests.html @@ -1 +1 @@ -interfaceDatastoreTests | IPFS Stores
                                                                                                                  \ No newline at end of file +interfaceDatastoreTests | IPFS Stores
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.index.FsBlockstoreInit.html b/interfaces/blockstore_fs.index.FsBlockstoreInit.html index 0c535130..80f953aa 100644 --- a/interfaces/blockstore_fs.index.FsBlockstoreInit.html +++ b/interfaces/blockstore_fs.index.FsBlockstoreInit.html @@ -1,4 +1,4 @@ -FsBlockstoreInit | IPFS Stores
                                                                                                                  interface FsBlockstoreInit {
                                                                                                                      createIfMissing?: boolean;
                                                                                                                      deleteManyConcurrency?: number;
                                                                                                                      errorIfExists?: boolean;
                                                                                                                      extension?: string;
                                                                                                                      getManyConcurrency?: number;
                                                                                                                      putManyConcurrency?: number;
                                                                                                                      shardingStrategy?: ShardingStrategy;
                                                                                                                  }

                                                                                                                  Properties

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

                                                                                                                  Properties

                                                                                                                  createIfMissing?: boolean

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

                                                                                                                  -
                                                                                                                  deleteManyConcurrency?: number

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

                                                                                                                  deleteManyConcurrency?: number

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

                                                                                                                  -
                                                                                                                  errorIfExists?: boolean

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

                                                                                                                  errorIfExists?: boolean

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

                                                                                                                  -
                                                                                                                  extension?: string

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

                                                                                                                  -
                                                                                                                  getManyConcurrency?: number

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

                                                                                                                  extension?: string

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

                                                                                                                  +
                                                                                                                  getManyConcurrency?: number

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

                                                                                                                  -
                                                                                                                  putManyConcurrency?: number

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

                                                                                                                  putManyConcurrency?: number

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

                                                                                                                  -
                                                                                                                  shardingStrategy?: ShardingStrategy

                                                                                                                  Control how CIDs map to paths and back

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  shardingStrategy?: ShardingStrategy

                                                                                                                  Control how CIDs map to paths and back

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html b/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html index d2c0f92c..372407ec 100644 --- a/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html +++ b/interfaces/blockstore_fs.sharding.FlatDirectoryInit.html @@ -1,8 +1,8 @@ -FlatDirectoryInit | IPFS Stores
                                                                                                                  interface FlatDirectoryInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      extension?: string;
                                                                                                                      prefixLength?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base? +FlatDirectoryInit | IPFS Stores
                                                                                                                  interface FlatDirectoryInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      extension?: string;
                                                                                                                      prefixLength?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base?: MultibaseCodec<string>

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

                                                                                                                  -
                                                                                                                  extension?: string

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

                                                                                                                  -
                                                                                                                  prefixLength?: number

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

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  extension?: string

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

                                                                                                                  +
                                                                                                                  prefixLength?: number

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

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.NextToLastInit.html b/interfaces/blockstore_fs.sharding.NextToLastInit.html index 38f743c6..25aa1204 100644 --- a/interfaces/blockstore_fs.sharding.NextToLastInit.html +++ b/interfaces/blockstore_fs.sharding.NextToLastInit.html @@ -1,8 +1,8 @@ -NextToLastInit | IPFS Stores
                                                                                                                  interface NextToLastInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      extension?: string;
                                                                                                                      prefixLength?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base? +NextToLastInit | IPFS Stores
                                                                                                                  interface NextToLastInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      extension?: string;
                                                                                                                      prefixLength?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base?: MultibaseCodec<string>

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

                                                                                                                  -
                                                                                                                  extension?: string

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

                                                                                                                  -
                                                                                                                  prefixLength?: number

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

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  extension?: string

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

                                                                                                                  +
                                                                                                                  prefixLength?: number

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

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_fs.sharding.ShardingStrategy.html b/interfaces/blockstore_fs.sharding.ShardingStrategy.html index 135b830b..bf5f1d2e 100644 --- a/interfaces/blockstore_fs.sharding.ShardingStrategy.html +++ b/interfaces/blockstore_fs.sharding.ShardingStrategy.html @@ -1,4 +1,4 @@ -ShardingStrategy | IPFS Stores
                                                                                                                  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 {
                                                                                                                      extension: string;
                                                                                                                      decode(path): CID<unknown, number, number, Version>;
                                                                                                                      encode(cid): {
                                                                                                                          dir: string;
                                                                                                                          file: string;
                                                                                                                      };
                                                                                                                  }

                                                                                                                  Implemented by

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Properties

                                                                                                                  extension: string

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    Returns {
                                                                                                                        dir: string;
                                                                                                                        file: string;
                                                                                                                    }

                                                                                                                    • dir: string
                                                                                                                    • file: string
                                                                                                                  \ No newline at end of file +

                                                                                                                  Properties

                                                                                                                  extension: string

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    Returns {
                                                                                                                        dir: string;
                                                                                                                        file: string;
                                                                                                                    }

                                                                                                                    • dir: string
                                                                                                                    • file: string
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_idb.IDBBlockstoreInit.html b/interfaces/blockstore_idb.IDBBlockstoreInit.html index d56b09b6..99e6cb52 100644 --- a/interfaces/blockstore_idb.IDBBlockstoreInit.html +++ b/interfaces/blockstore_idb.IDBBlockstoreInit.html @@ -1,8 +1,8 @@ -IDBBlockstoreInit | IPFS Stores
                                                                                                                  interface IDBBlockstoreInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      prefix?: string;
                                                                                                                      version?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base? +IDBBlockstoreInit | IPFS Stores
                                                                                                                  interface IDBBlockstoreInit {
                                                                                                                      base?: MultibaseCodec<string>;
                                                                                                                      prefix?: string;
                                                                                                                      version?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  base?: MultibaseCodec<string>

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

                                                                                                                  -
                                                                                                                  prefix?: string

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

                                                                                                                  -
                                                                                                                  version?: number

                                                                                                                  The database version (default: 1)

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  prefix?: string

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

                                                                                                                  +
                                                                                                                  version?: number

                                                                                                                  The database version (default: 1)

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_level.LevelBlockstoreInit.html b/interfaces/blockstore_level.LevelBlockstoreInit.html index 71d1ddde..1951e9ff 100644 --- a/interfaces/blockstore_level.LevelBlockstoreInit.html +++ b/interfaces/blockstore_level.LevelBlockstoreInit.html @@ -1,4 +1,4 @@ -LevelBlockstoreInit | IPFS Stores
                                                                                                                  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 {
                                                                                                                      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?: MultibaseCodec<string>

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

                                                                                                                  -
                                                                                                                  blockRestartInterval?: number

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

                                                                                                                  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 250bc3a9..2a821a6b 100644 --- a/interfaces/blockstore_s3.S3BlockstoreInit.html +++ b/interfaces/blockstore_s3.S3BlockstoreInit.html @@ -1,5 +1,5 @@ -S3BlockstoreInit | IPFS Stores

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

                                                                                                                  Properties

                                                                                                                  createIfMissing? +S3BlockstoreInit | IPFS Stores
                                                                                                                  interface S3BlockstoreInit {
                                                                                                                      createIfMissing?: boolean;
                                                                                                                      shardingStrategy?: ShardingStrategy;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  createIfMissing?: boolean

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

                                                                                                                  -
                                                                                                                  shardingStrategy?: ShardingStrategy

                                                                                                                  Control how CIDs map to paths and back

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  shardingStrategy?: ShardingStrategy

                                                                                                                  Control how CIDs map to paths and back

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/blockstore_s3.ShardingStrategy.html b/interfaces/blockstore_s3.ShardingStrategy.html index 0ab7f47a..ee9bee49 100644 --- a/interfaces/blockstore_s3.ShardingStrategy.html +++ b/interfaces/blockstore_s3.ShardingStrategy.html @@ -1,4 +1,4 @@ -ShardingStrategy | IPFS Stores
                                                                                                                  interface ShardingStrategy {
                                                                                                                      extension: string;
                                                                                                                      decode(path): CID<unknown, number, number, Version>;
                                                                                                                      encode(cid): string;
                                                                                                                  }

                                                                                                                  Properties

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

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Properties

                                                                                                                  extension: string

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file +

                                                                                                                  Properties

                                                                                                                  extension: string

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_core.index.KeyTransform.html b/interfaces/datastore_core.index.KeyTransform.html index 95891675..18a4b641 100644 --- a/interfaces/datastore_core.index.KeyTransform.html +++ b/interfaces/datastore_core.index.KeyTransform.html @@ -1,3 +1,3 @@ -KeyTransform | IPFS Stores
                                                                                                                  interface KeyTransform {
                                                                                                                      convert(key): Key;
                                                                                                                      invert(key): Key;
                                                                                                                  }

                                                                                                                  Methods

                                                                                                                  convert +KeyTransform | IPFS Stores
                                                                                                                  interface KeyTransform {
                                                                                                                      convert(key): Key;
                                                                                                                      invert(key): Key;
                                                                                                                  }

                                                                                                                  Methods

                                                                                                                  Methods

                                                                                                                  \ No newline at end of file +

                                                                                                                  Methods

                                                                                                                  \ 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 b87f3f7d..aed4ac51 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 {
                                                                                                                      _padding: string;
                                                                                                                      name: string;
                                                                                                                      param: number;
                                                                                                                      fun(s): string;
                                                                                                                      toString(): string;
                                                                                                                  }

                                                                                                                  Implemented by

                                                                                                                  Properties

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

                                                                                                                  Implemented by

                                                                                                                  Properties

                                                                                                                  Methods

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    • s: string

                                                                                                                    Returns string

                                                                                                                  \ No newline at end of file +

                                                                                                                  Properties

                                                                                                                  _padding: string
                                                                                                                  name: string
                                                                                                                  param: number

                                                                                                                  Methods

                                                                                                                  • Parameters

                                                                                                                    • s: string

                                                                                                                    Returns string

                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_fs.FsDatastoreInit.html b/interfaces/datastore_fs.FsDatastoreInit.html index 94687143..cf4681fa 100644 --- a/interfaces/datastore_fs.FsDatastoreInit.html +++ b/interfaces/datastore_fs.FsDatastoreInit.html @@ -1,7 +1,7 @@ -FsDatastoreInit | IPFS Stores
                                                                                                                  interface FsDatastoreInit {
                                                                                                                      createIfMissing?: boolean;
                                                                                                                      deleteManyConcurrency?: number;
                                                                                                                      errorIfExists?: boolean;
                                                                                                                      extension?: string;
                                                                                                                      getManyConcurrency?: number;
                                                                                                                      putManyConcurrency?: number;
                                                                                                                  }

                                                                                                                  Properties

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

                                                                                                                  Properties

                                                                                                                  createIfMissing?: boolean
                                                                                                                  deleteManyConcurrency?: number
                                                                                                                  errorIfExists?: boolean
                                                                                                                  extension?: string
                                                                                                                  getManyConcurrency?: number
                                                                                                                  putManyConcurrency?: number
                                                                                                                  \ No newline at end of file +

                                                                                                                  Properties

                                                                                                                  createIfMissing?: boolean
                                                                                                                  deleteManyConcurrency?: number
                                                                                                                  errorIfExists?: boolean
                                                                                                                  extension?: string
                                                                                                                  getManyConcurrency?: number
                                                                                                                  putManyConcurrency?: number
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_idb.IDBDatastoreInit.html b/interfaces/datastore_idb.IDBDatastoreInit.html index 24a26f5a..e29ad8af 100644 --- a/interfaces/datastore_idb.IDBDatastoreInit.html +++ b/interfaces/datastore_idb.IDBDatastoreInit.html @@ -1,5 +1,5 @@ -IDBDatastoreInit | IPFS Stores
                                                                                                                  interface IDBDatastoreInit {
                                                                                                                      prefix?: string;
                                                                                                                      version?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  prefix? +IDBDatastoreInit | IPFS Stores
                                                                                                                  interface IDBDatastoreInit {
                                                                                                                      prefix?: string;
                                                                                                                      version?: number;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  Properties

                                                                                                                  prefix?: string

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

                                                                                                                  -
                                                                                                                  version?: number

                                                                                                                  The database version (default: 1)

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  version?: number

                                                                                                                  The database version (default: 1)

                                                                                                                  +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/datastore_s3.S3DatastoreInit.html b/interfaces/datastore_s3.S3DatastoreInit.html index 60a2df05..e5055975 100644 --- a/interfaces/datastore_s3.S3DatastoreInit.html +++ b/interfaces/datastore_s3.S3DatastoreInit.html @@ -1,10 +1,10 @@ -S3DatastoreInit | IPFS Stores
                                                                                                                  interface S3DatastoreInit {
                                                                                                                      createIfMissing?: boolean;
                                                                                                                      path?: string;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  createIfMissing? +S3DatastoreInit | IPFS Stores
                                                                                                                  interface S3DatastoreInit {
                                                                                                                      createIfMissing?: boolean;
                                                                                                                      path?: string;
                                                                                                                  }

                                                                                                                  Properties

                                                                                                                  createIfMissing?: boolean

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

                                                                                                                  -
                                                                                                                  path?: string

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

                                                                                                                  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

                                                                                                                  -
                                                                                                                  \ No newline at end of file +
                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface_blockstore.Blockstore.html b/interfaces/interface_blockstore.Blockstore.html index 3d3f153c..09b64770 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 @@
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQuery.html b/interfaces/interface_datastore.index.KeyQuery.html index ee7f8521..0b93ffc9 100644 --- a/interfaces/interface_datastore.index.KeyQuery.html +++ b/interfaces/interface_datastore.index.KeyQuery.html @@ -1,6 +1,6 @@ -KeyQuery | IPFS Stores
                                                                                                                      interface KeyQuery {
                                                                                                                          filters?: KeyQueryFilter[];
                                                                                                                          limit?: number;
                                                                                                                          offset?: number;
                                                                                                                          orders?: KeyQueryOrder[];
                                                                                                                          prefix?: string;
                                                                                                                      }

                                                                                                                      Properties

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

                                                                                                                      Properties

                                                                                                                      filters?: KeyQueryFilter[]
                                                                                                                      limit?: number
                                                                                                                      offset?: number
                                                                                                                      orders?: KeyQueryOrder[]
                                                                                                                      prefix?: string
                                                                                                                      \ No newline at end of file +

                                                                                                                      Properties

                                                                                                                      filters?: KeyQueryFilter[]
                                                                                                                      limit?: number
                                                                                                                      offset?: number
                                                                                                                      orders?: KeyQueryOrder[]
                                                                                                                      prefix?: string
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryFilter.html b/interfaces/interface_datastore.index.KeyQueryFilter.html index 2587b6b7..145cce87 100644 --- a/interfaces/interface_datastore.index.KeyQueryFilter.html +++ b/interfaces/interface_datastore.index.KeyQueryFilter.html @@ -1 +1 @@ -KeyQueryFilter | IPFS Stores
                                                                                                                      interface KeyQueryFilter ((item) => boolean)
                                                                                                                      \ No newline at end of file +KeyQueryFilter | IPFS Stores
                                                                                                                      interface KeyQueryFilter ((item) => boolean)
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.KeyQueryOrder.html b/interfaces/interface_datastore.index.KeyQueryOrder.html index 35f118a3..fd1b8bf6 100644 --- a/interfaces/interface_datastore.index.KeyQueryOrder.html +++ b/interfaces/interface_datastore.index.KeyQueryOrder.html @@ -1 +1 @@ -KeyQueryOrder | IPFS Stores
                                                                                                                      interface KeyQueryOrder ((a, b) => -1 | 0 | 1)
                                                                                                                      \ No newline at end of file +KeyQueryOrder | IPFS Stores
                                                                                                                      interface KeyQueryOrder ((a, b) => -1 | 0 | 1)
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Pair.html b/interfaces/interface_datastore.index.Pair.html index 818d78ce..5f90536d 100644 --- a/interfaces/interface_datastore.index.Pair.html +++ b/interfaces/interface_datastore.index.Pair.html @@ -1,3 +1,3 @@ -Pair | IPFS Stores
                                                                                                                      interface Pair {
                                                                                                                          key: Key;
                                                                                                                          value: Uint8Array;
                                                                                                                      }

                                                                                                                      Properties

                                                                                                                      key +Pair | IPFS Stores
                                                                                                                      interface Pair {
                                                                                                                          key: Key;
                                                                                                                          value: Uint8Array;
                                                                                                                      }

                                                                                                                      Properties

                                                                                                                      Properties

                                                                                                                      key: Key
                                                                                                                      value: Uint8Array
                                                                                                                      \ No newline at end of file +

                                                                                                                      Properties

                                                                                                                      key: Key
                                                                                                                      value: Uint8Array
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.Query.html b/interfaces/interface_datastore.index.Query.html index b7b18122..f6c85e33 100644 --- a/interfaces/interface_datastore.index.Query.html +++ b/interfaces/interface_datastore.index.Query.html @@ -1,6 +1,6 @@ -Query | IPFS Stores
                                                                                                                      interface Query {
                                                                                                                          filters?: QueryFilter[];
                                                                                                                          limit?: number;
                                                                                                                          offset?: number;
                                                                                                                          orders?: QueryOrder[];
                                                                                                                          prefix?: string;
                                                                                                                      }

                                                                                                                      Properties

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

                                                                                                                      Properties

                                                                                                                      filters?: QueryFilter[]
                                                                                                                      limit?: number
                                                                                                                      offset?: number
                                                                                                                      orders?: QueryOrder[]
                                                                                                                      prefix?: string
                                                                                                                      \ No newline at end of file +

                                                                                                                      Properties

                                                                                                                      filters?: QueryFilter[]
                                                                                                                      limit?: number
                                                                                                                      offset?: number
                                                                                                                      orders?: QueryOrder[]
                                                                                                                      prefix?: string
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryFilter.html b/interfaces/interface_datastore.index.QueryFilter.html index fcc868b3..cf443320 100644 --- a/interfaces/interface_datastore.index.QueryFilter.html +++ b/interfaces/interface_datastore.index.QueryFilter.html @@ -1 +1 @@ -QueryFilter | IPFS Stores
                                                                                                                      interface QueryFilter ((item) => boolean)
                                                                                                                      \ No newline at end of file +QueryFilter | IPFS Stores
                                                                                                                      interface QueryFilter ((item) => boolean)
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore.index.QueryOrder.html b/interfaces/interface_datastore.index.QueryOrder.html index 532059ad..e10686b8 100644 --- a/interfaces/interface_datastore.index.QueryOrder.html +++ b/interfaces/interface_datastore.index.QueryOrder.html @@ -1 +1 @@ -QueryOrder | IPFS Stores
                                                                                                                      interface QueryOrder ((a, b) => -1 | 0 | 1)
                                                                                                                      \ No newline at end of file +QueryOrder | IPFS Stores
                                                                                                                      interface QueryOrder ((a, b) => -1 | 0 | 1)
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_datastore_tests.InterfacDatastoreTest.html b/interfaces/interface_datastore_tests.InterfacDatastoreTest.html index 9502a13a..bfaea316 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> {
                                                                                                                          setup(): D | Promise<D>;
                                                                                                                          teardown(store): void | Promise<void>;
                                                                                                                      }

                                                                                                                      Type Parameters

                                                                                                                      Methods

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

                                                                                                                      Type Parameters

                                                                                                                      Methods

                                                                                                                      Methods

                                                                                                                      \ No newline at end of file +

                                                                                                                      Methods

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

                                                                                                                      Options for async operations.

                                                                                                                      -
                                                                                                                      interface AbortOptions {
                                                                                                                          signal?: AbortSignal;
                                                                                                                      }

                                                                                                                      Properties

                                                                                                                      Properties

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

                                                                                                                      Properties

                                                                                                                      Properties

                                                                                                                      signal?: AbortSignal
                                                                                                                      \ No newline at end of file diff --git a/interfaces/interface_store.Store.html b/interfaces/interface_store.Store.html index 78ef8471..1e4e19c3 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

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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          BaseBlockstore +base | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.black_hole.html b/modules/blockstore_core.black_hole.html index bce10b9d..4659934c 100644 --- a/modules/blockstore_core.black_hole.html +++ b/modules/blockstore_core.black_hole.html @@ -1,2 +1,2 @@ -black-hole | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          BlackHoleBlockstore +black-hole | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.identity.html b/modules/blockstore_core.identity.html index a999047f..33938ba5 100644 --- a/modules/blockstore_core.identity.html +++ b/modules/blockstore_core.identity.html @@ -1,2 +1,2 @@ -identity | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          IdentityBlockstore +identity | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.index.html b/modules/blockstore_core.index.html index 5477f405..4f263094 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

                                                                                                                          References

                                                                                                                          BaseBlockstore BlackHoleBlockstore MemoryBlockstore TieredBlockstore diff --git a/modules/blockstore_core.memory.html b/modules/blockstore_core.memory.html index 08fc41f2..35bf8159 100644 --- a/modules/blockstore_core.memory.html +++ b/modules/blockstore_core.memory.html @@ -1,2 +1,2 @@ -memory | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          MemoryBlockstore +memory | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_core.tiered.html b/modules/blockstore_core.tiered.html index 66f7511f..62d3b58c 100644 --- a/modules/blockstore_core.tiered.html +++ b/modules/blockstore_core.tiered.html @@ -1,2 +1,2 @@ -tiered | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          TieredBlockstore +tiered | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/blockstore_fs.index.html b/modules/blockstore_fs.index.html index feb22ca8..1039dd04 100644 --- a/modules/blockstore_fs.index.html +++ b/modules/blockstore_fs.index.html @@ -1,6 +1,6 @@ index | IPFS Stores

                                                                                                                          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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          Interfaces

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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          FlatDirectory +sharding | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          Interfaces

                                                                                                                          FlatDirectoryInit NextToLastInit diff --git a/modules/datastore_core.base.html b/modules/datastore_core.base.html index b8d88dc4..cf4c790b 100644 --- a/modules/datastore_core.base.html +++ b/modules/datastore_core.base.html @@ -1,2 +1,2 @@ -base | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          BaseDatastore +base | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          BlackHoleDatastore +black-hole | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.index.html b/modules/datastore_core.index.html index 034ad7f4..48b46200 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

                                                                                                                          References

                                                                                                                          BaseDatastore KeyTransformDatastore MemoryDatastore MountDatastore diff --git a/modules/datastore_core.keytransform.html b/modules/datastore_core.keytransform.html index e0a323ba..8931b3c0 100644 --- a/modules/datastore_core.keytransform.html +++ b/modules/datastore_core.keytransform.html @@ -1,2 +1,2 @@ -keytransform | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          KeyTransformDatastore +keytransform | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.memory.html b/modules/datastore_core.memory.html index 1a520767..726b5810 100644 --- a/modules/datastore_core.memory.html +++ b/modules/datastore_core.memory.html @@ -1,2 +1,2 @@ -memory | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          MemoryDatastore +memory | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.mount.html b/modules/datastore_core.mount.html index 3d82b02a..136a6880 100644 --- a/modules/datastore_core.mount.html +++ b/modules/datastore_core.mount.html @@ -1,2 +1,2 @@ -mount | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          MountDatastore +mount | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

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

                                                                                                                          Index

                                                                                                                          Classes

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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          NextToLast +shard | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

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

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          ShardingDatastore +sharding | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/datastore_core.tiered.html b/modules/datastore_core.tiered.html index 02bffa66..ebb99633 100644 --- a/modules/datastore_core.tiered.html +++ b/modules/datastore_core.tiered.html @@ -1,2 +1,2 @@ -tiered | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          TieredDatastore +tiered | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/modules/interface_datastore.index.html b/modules/interface_datastore.index.html index 801e68dc..0f5f26ea 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

                                                                                                                          Interfaces

                                                                                                                          Batch Datastore KeyQuery diff --git a/modules/interface_datastore.key.html b/modules/interface_datastore.key.html index 6f6834f5..79c1f17a 100644 --- a/modules/interface_datastore.key.html +++ b/modules/interface_datastore.key.html @@ -1,2 +1,2 @@ -key | IPFS Stores

                                                                                                                          Index

                                                                                                                          Classes

                                                                                                                          Key +key | IPFS Stores
                                                                                                                          \ No newline at end of file diff --git a/types/interface_store.Await.html b/types/interface_store.Await.html index d797fcee..6b8905f1 100644 --- a/types/interface_store.Await.html +++ b/types/interface_store.Await.html @@ -1,2 +1,2 @@ Await | IPFS Stores
                                                                                                                          Await<T>: Promise<T> | T

                                                                                                                          A value or a promise of a value

                                                                                                                          -

                                                                                                                          Type Parameters

                                                                                                                          • T
                                                                                                                          \ No newline at end of file +

                                                                                                                          Type Parameters

                                                                                                                          • T
                                                                                                                          \ No newline at end of file diff --git a/types/interface_store.AwaitIterable.html b/types/interface_store.AwaitIterable.html index 6b92a4c5..60acde31 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
                                                                                                                          \ No newline at end of file +

                                                                                                                          Type Parameters

                                                                                                                          • T
                                                                                                                          \ 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 cfaf0fa1..5f210919 100644 --- a/variables/datastore_core.shard.PREFIX-1.html +++ b/variables/datastore_core.shard.PREFIX-1.html @@ -1 +1 @@ -PREFIX | IPFS Stores
                                                                                                                          PREFIX: "/repo/flatfs/shard/" = '/repo/flatfs/shard/'
                                                                                                                          \ No newline at end of file +PREFIX | IPFS Stores
                                                                                                                          PREFIX: "/repo/flatfs/shard/" = '/repo/flatfs/shard/'
                                                                                                                          \ 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 0f72fb2e..7e941dba 100644 --- a/variables/datastore_core.shard.SHARDING_FN.html +++ b/variables/datastore_core.shard.SHARDING_FN.html @@ -1 +1 @@ -SHARDING_FN | IPFS Stores
                                                                                                                          SHARDING_FN: "SHARDING" = 'SHARDING'
                                                                                                                          \ No newline at end of file +SHARDING_FN | IPFS Stores
                                                                                                                          SHARDING_FN: "SHARDING" = 'SHARDING'
                                                                                                                          \ No newline at end of file