diff --git a/classes/_helia_unixfs.errors.AlreadyExistsError.html b/classes/_helia_unixfs.errors.AlreadyExistsError.html index 59d2b90b0..b658db31a 100644 --- a/classes/_helia_unixfs.errors.AlreadyExistsError.html +++ b/classes/_helia_unixfs.errors.AlreadyExistsError.html @@ -1,4 +1,4 @@ -AlreadyExistsError | Helia

Hierarchy (view full)

Constructors

constructor +AlreadyExistsError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.DoesNotExistError.html b/classes/_helia_unixfs.errors.DoesNotExistError.html index 1832eabc2..97d3c671c 100644 --- a/classes/_helia_unixfs.errors.DoesNotExistError.html +++ b/classes/_helia_unixfs.errors.DoesNotExistError.html @@ -1,4 +1,4 @@ -DoesNotExistError | Helia

Hierarchy (view full)

Constructors

constructor +DoesNotExistError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.InvalidPBNodeError.html b/classes/_helia_unixfs.errors.InvalidPBNodeError.html index c155de0e1..1c82d309f 100644 --- a/classes/_helia_unixfs.errors.InvalidPBNodeError.html +++ b/classes/_helia_unixfs.errors.InvalidPBNodeError.html @@ -1,4 +1,4 @@ -InvalidPBNodeError | Helia

Hierarchy (view full)

Constructors

constructor +InvalidPBNodeError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.InvalidParametersError.html b/classes/_helia_unixfs.errors.InvalidParametersError.html index 936eebd7e..930c0efd3 100644 --- a/classes/_helia_unixfs.errors.InvalidParametersError.html +++ b/classes/_helia_unixfs.errors.InvalidParametersError.html @@ -1,4 +1,4 @@ -InvalidParametersError | Helia

Hierarchy (view full)

Constructors

constructor +InvalidParametersError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.NoContentError.html b/classes/_helia_unixfs.errors.NoContentError.html index 64dac8da2..536968f3e 100644 --- a/classes/_helia_unixfs.errors.NoContentError.html +++ b/classes/_helia_unixfs.errors.NoContentError.html @@ -1,4 +1,4 @@ -NoContentError | Helia

Hierarchy (view full)

Constructors

constructor +NoContentError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.NotADirectoryError.html b/classes/_helia_unixfs.errors.NotADirectoryError.html index 273b56aff..2ea3536e1 100644 --- a/classes/_helia_unixfs.errors.NotADirectoryError.html +++ b/classes/_helia_unixfs.errors.NotADirectoryError.html @@ -1,4 +1,4 @@ -NotADirectoryError | Helia

Hierarchy (view full)

Constructors

constructor +NotADirectoryError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.NotAFileError.html b/classes/_helia_unixfs.errors.NotAFileError.html index b9f5e197d..b467445b0 100644 --- a/classes/_helia_unixfs.errors.NotAFileError.html +++ b/classes/_helia_unixfs.errors.NotAFileError.html @@ -1,4 +1,4 @@ -NotAFileError | Helia

Hierarchy (view full)

Constructors

constructor +NotAFileError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.NotUnixFSError.html b/classes/_helia_unixfs.errors.NotUnixFSError.html index acd2c5d6d..7c0b191fb 100644 --- a/classes/_helia_unixfs.errors.NotUnixFSError.html +++ b/classes/_helia_unixfs.errors.NotUnixFSError.html @@ -1,4 +1,4 @@ -NotUnixFSError | Helia

Hierarchy (view full)

Constructors

constructor +NotUnixFSError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.UnixFSError.html b/classes/_helia_unixfs.errors.UnixFSError.html index 735b323bd..d43599443 100644 --- a/classes/_helia_unixfs.errors.UnixFSError.html +++ b/classes/_helia_unixfs.errors.UnixFSError.html @@ -1,4 +1,4 @@ -UnixFSError | Helia

Class UnixFSErrorAbstract

Hierarchy (view full)

Constructors

constructor +UnixFSError | Helia

Class UnixFSErrorAbstract

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_unixfs.errors.UnknownError.html b/classes/_helia_unixfs.errors.UnknownError.html index 4913ab88f..af0000b6f 100644 --- a/classes/_helia_unixfs.errors.UnknownError.html +++ b/classes/_helia_unixfs.errors.UnknownError.html @@ -1,4 +1,4 @@ -UnknownError | Helia

Hierarchy (view full)

Constructors

constructor +UnknownError | Helia

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

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

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: string
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 diff --git a/classes/_helia_utils.AbstractSession.html b/classes/_helia_utils.AbstractSession.html index fd46587e5..174ecaa08 100644 --- a/classes/_helia_utils.AbstractSession.html +++ b/classes/_helia_utils.AbstractSession.html @@ -1,4 +1,4 @@ -AbstractSession | Helia

Class AbstractSession<Provider, RetrieveBlockProgressEvents>Abstract

Type Parameters

Hierarchy

Implements

Constructors

constructor +AbstractSession | Helia

Class AbstractSession<Provider, RetrieveBlockProgressEvents>Abstract

Type Parameters

Hierarchy

Implements

Constructors

Properties

#private: any
evictionFilter: BloomFilter
intialPeerSearchComplete?: Promise<void>
log: Logger
maxProviders: number
minProviders: number
name: string
providers: Provider[]
requests: Map<string, Promise<Uint8Array>>

Methods

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

  • Parameters

    Returns boolean

  • Parameters

    • type: string

    Returns number

  • The subclass should contact the provider and request the block from it.

    +

Constructors

Properties

#private: any
evictionFilter: BloomFilter
intialPeerSearchComplete?: Promise<void>
log: Logger
maxProviders: number
minProviders: number
name: string
providers: Provider[]
requests: Map<string, Promise<Uint8Array>>

Methods

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

  • Parameters

    Returns boolean

  • Parameters

    • type: string

    Returns number

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

  • Type Parameters

    • Detail

    Parameters

    • type: "provider"
    • Optional detail: CustomEventInit<Detail>

    Returns boolean

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

  • Type Parameters

    • Detail

    Parameters

    • type: "provider"
    • Optional detail: CustomEventInit<Detail>

    Returns boolean

\ No newline at end of file +

Parameters

Returns string | Uint8Array

\ No newline at end of file diff --git a/classes/_helia_utils.BloomFilter.html b/classes/_helia_utils.BloomFilter.html index adf11dc8f..b3daeb60e 100644 --- a/classes/_helia_utils.BloomFilter.html +++ b/classes/_helia_utils.BloomFilter.html @@ -1,4 +1,4 @@ -BloomFilter | Helia

Constructors

constructor +BloomFilter | Helia

Constructors

Properties

bits buffer seeds @@ -8,11 +8,11 @@ has setbit create -

Constructors

Properties

bits: number
buffer: Uint8Array
seeds: number[]

Methods

  • Test if the filter has an item. If it returns false it definitely does not +

Constructors

Properties

bits: number
buffer: Uint8Array
seeds: number[]

Methods

  • Test if the filter has an item. If it returns false it definitely does not have the item. If it returns true, it probably has the item but there's an errorRate chance it doesn't.

    -

    Parameters

    Returns boolean

\ No newline at end of file +

Parameters

Returns BloomFilter

\ No newline at end of file diff --git a/classes/_helia_utils.Helia.html b/classes/_helia_utils.Helia.html index 600dc63a7..0413b7d17 100644 --- a/classes/_helia_utils.Helia.html +++ b/classes/_helia_utils.Helia.html @@ -1,5 +1,5 @@ Helia | Helia

The API presented by a Helia node

-

Implements

Constructors

Implements

Constructors

Properties

blockstore dagWalkers datastore @@ -13,21 +13,21 @@

Methods

Constructors

Properties

blockstore: BlockStorage

Where the blocks are stored

-
dagWalkers: Record<number, DAGWalker>

DAGWalkers are codec-specific implementations that know how to yield all +

Constructors

Properties

blockstore: BlockStorage

Where the blocks are stored

+
dagWalkers: Record<number, DAGWalker>

DAGWalkers are codec-specific implementations that know how to yield all CIDs contained within a block that corresponds to that codec.

-
datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

A key/value store

-

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      dns: DNS

                      The DNS property can be used to perform lookups of various record types and +

                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                      A key/value store

                      +

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          dns: DNS

                                          The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

                                          -
                                          hashers: Record<number, MultihashHasher<number>>

                                          Hashers can be used to hash a piece of data with the specified hashing +

                                          hashers: Record<number, MultihashHasher<number>>

                                          Hashers can be used to hash a piece of data with the specified hashing algorithm.

                                          -
                                          log: Logger

                                          A logging component that can be reused by consumers

                                          -
                                          metrics?: Metrics

                                          A metrics object that can be used to collected arbitrary stats about node +

                                          log: Logger

                                          A logging component that can be reused by consumers

                                          +
                                          metrics?: Metrics

                                          A metrics object that can be used to collected arbitrary stats about node usage.

                                          -
                                          pins: Pins

                                          Pinning operations for blocks in the blockstore

                                          -
                                          routing: Routing

                                          The routing component allows performing operations such as looking up +

                                          pins: Pins

                                          Pinning operations for blocks in the blockstore

                                          +
                                          routing: Routing

                                          The routing component allows performing operations such as looking up content providers, information about peers, etc.

                                          -

                                          Methods

                                          \ No newline at end of file +

                                          Methods

                                          \ No newline at end of file diff --git a/functions/_helia_bitswap.createBitswap.html b/functions/_helia_bitswap.createBitswap.html index 297c5fcf5..b8b7f2ca1 100644 --- a/functions/_helia_bitswap.createBitswap.html +++ b/functions/_helia_bitswap.createBitswap.html @@ -1 +1 @@ -createBitswap | Helia

                                          Function createBitswap

                                          \ No newline at end of file +createBitswap | Helia

                                          Function createBitswap

                                          \ No newline at end of file diff --git a/functions/_helia_block_brokers.bitswap.html b/functions/_helia_block_brokers.bitswap.html index 362f5eae0..65d38e4aa 100644 --- a/functions/_helia_block_brokers.bitswap.html +++ b/functions/_helia_block_brokers.bitswap.html @@ -1,3 +1,3 @@ bitswap | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns ((components) => BlockBroker)

                                          \ No newline at end of file diff --git a/functions/_helia_block_brokers.trustlessGateway.html b/functions/_helia_block_brokers.trustlessGateway.html index d1b971a93..b1707ea51 100644 --- a/functions/_helia_block_brokers.trustlessGateway.html +++ b/functions/_helia_block_brokers.trustlessGateway.html @@ -1 +1 @@ -trustlessGateway | Helia
                                          \ No newline at end of file +trustlessGateway | Helia
                                          \ No newline at end of file diff --git a/functions/_helia_car.car-1.html b/functions/_helia_car.car-1.html index 370860b1c..f7ba49228 100644 --- a/functions/_helia_car.car-1.html +++ b/functions/_helia_car.car-1.html @@ -1,2 +1,2 @@ car | Helia

                                          Function car

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Car

                                          \ No newline at end of file diff --git a/functions/_helia_dag_cbor.dagCbor-1.html b/functions/_helia_dag_cbor.dagCbor-1.html index dbee78520..803acc048 100644 --- a/functions/_helia_dag_cbor.dagCbor-1.html +++ b/functions/_helia_dag_cbor.dagCbor-1.html @@ -1,2 +1,2 @@ dagCbor | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns DAGCBOR

                                          \ No newline at end of file diff --git a/functions/_helia_dag_json.dagJson-1.html b/functions/_helia_dag_json.dagJson-1.html index 51737cce0..a24cc17f8 100644 --- a/functions/_helia_dag_json.dagJson-1.html +++ b/functions/_helia_dag_json.dagJson-1.html @@ -1,2 +1,2 @@ dagJson | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns DAGJSON

                                          \ No newline at end of file diff --git a/functions/_helia_http.createHeliaHTTP.html b/functions/_helia_http.createHeliaHTTP.html index 39c333827..1624cbcb9 100644 --- a/functions/_helia_http.createHeliaHTTP.html +++ b/functions/_helia_http.createHeliaHTTP.html @@ -1,2 +1,2 @@ createHeliaHTTP | Helia

                                          Function createHeliaHTTP

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Promise<Helia>

                                          \ No newline at end of file diff --git a/functions/_helia_ipns.index.ipns-1.html b/functions/_helia_ipns.index.ipns-1.html index be4678663..2e7584bb6 100644 --- a/functions/_helia_ipns.index.ipns-1.html +++ b/functions/_helia_ipns.index.ipns-1.html @@ -1 +1 @@ -ipns | Helia
                                          \ No newline at end of file +ipns | Helia
                                          \ No newline at end of file diff --git a/functions/_helia_ipns.routing.helia.html b/functions/_helia_ipns.routing.helia.html index a214bba72..531ef2413 100644 --- a/functions/_helia_ipns.routing.helia.html +++ b/functions/_helia_ipns.routing.helia.html @@ -1,3 +1,3 @@ helia | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns IPNSRouting

                                          \ No newline at end of file diff --git a/functions/_helia_ipns.routing.pubsub.html b/functions/_helia_ipns.routing.pubsub.html index 7291d1429..9229e386e 100644 --- a/functions/_helia_ipns.routing.pubsub.html +++ b/functions/_helia_ipns.routing.pubsub.html @@ -3,4 +3,4 @@

                                          Note we must first be subscribed to the topic in order to receive updated records, so the first call to .get should be expected to fail!

                                          -

                                          Parameters

                                          Returns IPNSRouting

                                          \ No newline at end of file +

                                          Parameters

                                          Returns IPNSRouting

                                          \ No newline at end of file diff --git a/functions/_helia_json.json-1.html b/functions/_helia_json.json-1.html index 15d4d22bc..3b545d62a 100644 --- a/functions/_helia_json.json-1.html +++ b/functions/_helia_json.json-1.html @@ -1,2 +1,2 @@ json | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns JSON

                                          \ No newline at end of file diff --git a/functions/_helia_mfs.mfs-1.html b/functions/_helia_mfs.mfs-1.html index 00571d303..db19dd5b0 100644 --- a/functions/_helia_mfs.mfs-1.html +++ b/functions/_helia_mfs.mfs-1.html @@ -1,2 +1,2 @@ mfs | Helia

                                          Function mfs

                                          \ No newline at end of file +

                                          Parameters

                                          Returns MFS

                                          \ No newline at end of file diff --git a/functions/_helia_routers.delegatedHTTPRouting.html b/functions/_helia_routers.delegatedHTTPRouting.html index c77093da6..ca6396253 100644 --- a/functions/_helia_routers.delegatedHTTPRouting.html +++ b/functions/_helia_routers.delegatedHTTPRouting.html @@ -1,2 +1,2 @@ delegatedHTTPRouting | Helia

                                          Function delegatedHTTPRouting

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Routing

                                          \ No newline at end of file diff --git a/functions/_helia_routers.httpGatewayRouting.html b/functions/_helia_routers.httpGatewayRouting.html index 04b68f87b..be6e48896 100644 --- a/functions/_helia_routers.httpGatewayRouting.html +++ b/functions/_helia_routers.httpGatewayRouting.html @@ -1,2 +1,2 @@ httpGatewayRouting | Helia

                                          Function httpGatewayRouting

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Partial<Routing>

                                          \ No newline at end of file diff --git a/functions/_helia_routers.libp2pRouting.html b/functions/_helia_routers.libp2pRouting.html index cd5202a77..dd68a58a2 100644 --- a/functions/_helia_routers.libp2pRouting.html +++ b/functions/_helia_routers.libp2pRouting.html @@ -1 +1 @@ -libp2pRouting | Helia

                                          Function libp2pRouting

                                          \ No newline at end of file +libp2pRouting | Helia

                                          Function libp2pRouting

                                          \ No newline at end of file diff --git a/functions/_helia_strings.strings-1.html b/functions/_helia_strings.strings-1.html index 7a4b1189a..57392bb3a 100644 --- a/functions/_helia_strings.strings-1.html +++ b/functions/_helia_strings.strings-1.html @@ -1,2 +1,2 @@ strings | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns Strings

                                          \ No newline at end of file diff --git a/functions/_helia_unixfs.index.globSource.html b/functions/_helia_unixfs.index.globSource.html index a20dd51c4..c4d717566 100644 --- a/functions/_helia_unixfs.index.globSource.html +++ b/functions/_helia_unixfs.index.globSource.html @@ -1,2 +1,2 @@ globSource | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns AsyncGenerator<ImportCandidate & GlobSourceResult>

                                          \ No newline at end of file diff --git a/functions/_helia_unixfs.index.unixfs-1.html b/functions/_helia_unixfs.index.unixfs-1.html index 583b48b76..60a86794c 100644 --- a/functions/_helia_unixfs.index.unixfs-1.html +++ b/functions/_helia_unixfs.index.unixfs-1.html @@ -1,2 +1,2 @@ unixfs | Helia
                                          \ No newline at end of file +

                                          Parameters

                                          Returns UnixFS

                                          \ No newline at end of file diff --git a/functions/_helia_unixfs.index.urlSource.html b/functions/_helia_unixfs.index.urlSource.html index 1608aad60..8a46ff563 100644 --- a/functions/_helia_unixfs.index.urlSource.html +++ b/functions/_helia_unixfs.index.urlSource.html @@ -1 +1 @@ -urlSource | Helia
                                          \ No newline at end of file +urlSource | Helia
                                          \ No newline at end of file diff --git a/functions/helia.createHelia.html b/functions/helia.createHelia.html index 1b9a9ed36..93b6d3506 100644 --- a/functions/helia.createHelia.html +++ b/functions/helia.createHelia.html @@ -1,2 +1,2 @@ createHelia | Helia

                                          Function createHelia

                                          \ No newline at end of file +

                                          Type Parameters

                                          Parameters

                                          Returns Promise<HeliaLibp2p<T>>

                                        • Parameters

                                          Returns Promise<HeliaLibp2p<Libp2p<DefaultLibp2pServices>>>

                                        • \ No newline at end of file diff --git a/functions/helia.libp2pDefaults.html b/functions/helia.libp2pDefaults.html index 8be475803..b6e3006e4 100644 --- a/functions/helia.libp2pDefaults.html +++ b/functions/helia.libp2pDefaults.html @@ -1 +1 @@ -libp2pDefaults | Helia

                                          Function libp2pDefaults

                                          \ No newline at end of file +libp2pDefaults | Helia

                                          Function libp2pDefaults

                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.Bitswap.html b/interfaces/_helia_bitswap.Bitswap.html index c29d55c6d..d6b107fdb 100644 --- a/interfaces/_helia_bitswap.Bitswap.html +++ b/interfaces/_helia_bitswap.Bitswap.html @@ -1,4 +1,4 @@ -Bitswap | Helia
                                          interface Bitswap {
                                              afterStart?(): void | Promise<void>;
                                              afterStop?(): void | Promise<void>;
                                              beforeStart?(): void | Promise<void>;
                                              beforeStop?(): void | Promise<void>;
                                              createSession(options?): Required<Pick<BlockBroker<BitswapWantBlockProgressEvents, ProgressEvent<any, any>>, "retrieve">>;
                                              getPeerWantlist(peerId): undefined | WantListEntry[];
                                              getWantlist(): WantListEntry[];
                                              notify(cid, block, options?): Promise<void>;
                                              start(): void | Promise<void>;
                                              stop(): void | Promise<void>;
                                              want(cid, options?): Promise<Uint8Array>;
                                          }

                                          Hierarchy

                                          Methods

                                          afterStart? +Bitswap | Helia
                                          interface Bitswap {
                                              afterStart?(): void | Promise<void>;
                                              afterStop?(): void | Promise<void>;
                                              beforeStart?(): void | Promise<void>;
                                              beforeStop?(): void | Promise<void>;
                                              createSession(options?): Required<Pick<BlockBroker<BitswapWantBlockProgressEvents, ProgressEvent<any, any>>, "retrieve">>;
                                              getPeerWantlist(peerId): undefined | WantListEntry[];
                                              getWantlist(): WantListEntry[];
                                              notify(cid, block, options?): Promise<void>;
                                              start(): void | Promise<void>;
                                              stop(): void | Promise<void>;
                                              want(cid, options?): Promise<Uint8Array>;
                                          }

                                          Hierarchy

                                          Methods

                                          Returns void | Promise<void>

                                          • If implemented, this method will be invoked before the stop method.

                                            Any other components will still be running when this method is called.

                                            Returns void | Promise<void>

                                          • This method will be invoked to start the component.

                                            It should not assume that any other components have been started.

                                            Returns void | Promise<void>

                                          • This method will be invoked to stop the component.

                                            It should not assume any other components are running when it is called.

                                            Returns void | Promise<void>

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Promise<Uint8Array>

                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.BitswapComponents.html b/interfaces/_helia_bitswap.BitswapComponents.html index 81b298301..7ecad4678 100644 --- a/interfaces/_helia_bitswap.BitswapComponents.html +++ b/interfaces/_helia_bitswap.BitswapComponents.html @@ -1,6 +1,6 @@ -BitswapComponents | Helia

                                          Interface BitswapComponents

                                          interface BitswapComponents {
                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                              libp2p: Libp2p<ServiceMap>;
                                              logger: ComponentLogger;
                                              metrics?: Metrics;
                                              routing: Routing;
                                          }

                                          Properties

                                          blockstore +BitswapComponents | Helia

                                          Interface BitswapComponents

                                          interface BitswapComponents {
                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                              libp2p: Libp2p<ServiceMap>;
                                              logger: ComponentLogger;
                                              metrics?: Metrics;
                                              routing: Routing;
                                          }

                                          Properties

                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                          Type declaration

                                            Type declaration

                                              Type declaration

                                                Type declaration

                                                  Type declaration

                                                    Type declaration

                                                      Type declaration

                                                        Type declaration

                                                          metrics?: Metrics
                                                          routing: Routing
                                                          \ No newline at end of file +

                                                          Properties

                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                          Type declaration

                                                            Type declaration

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          metrics?: Metrics
                                                                          routing: Routing
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.BitswapOptions.html b/interfaces/_helia_bitswap.BitswapOptions.html index 279dc69c7..0e7cbaca7 100644 --- a/interfaces/_helia_bitswap.BitswapOptions.html +++ b/interfaces/_helia_bitswap.BitswapOptions.html @@ -1,4 +1,4 @@ -BitswapOptions | Helia

                                                                          Interface BitswapOptions

                                                                          interface BitswapOptions {
                                                                              hashLoader?: MultihashHasherLoader;
                                                                              incomingStreamTimeout?: number;
                                                                              maxInboundStreams?: number;
                                                                              maxIncomingMessageSize?: number;
                                                                              maxOutboundStreams?: number;
                                                                              maxOutgoingMessageSize?: number;
                                                                              maxSizeReplaceHasWithBlock?: number;
                                                                              messageSendConcurrency?: number;
                                                                              protocol?: string;
                                                                              runOnTransientConnections?: boolean;
                                                                              sendBlocksConcurrency?: number;
                                                                              sendBlocksDebounce?: number;
                                                                              sendBlocksTimeout?: number;
                                                                          }

                                                                          Properties

                                                                          hashLoader? +BitswapOptions | Helia

                                                                          Interface BitswapOptions

                                                                          interface BitswapOptions {
                                                                              hashLoader?: MultihashHasherLoader;
                                                                              incomingStreamTimeout?: number;
                                                                              maxInboundStreams?: number;
                                                                              maxIncomingMessageSize?: number;
                                                                              maxOutboundStreams?: number;
                                                                              maxOutgoingMessageSize?: number;
                                                                              maxSizeReplaceHasWithBlock?: number;
                                                                              messageSendConcurrency?: number;
                                                                              protocol?: string;
                                                                              runOnTransientConnections?: boolean;
                                                                              sendBlocksConcurrency?: number;
                                                                              sendBlocksDebounce?: number;
                                                                              sendBlocksTimeout?: number;
                                                                          }

                                                                          Properties

                                                                          Enables loading esoteric hash functions

                                                                          -
                                                                          incomingStreamTimeout?: number

                                                                          An incoming stream must resolve within this number of seconds

                                                                          +
                                                                          incomingStreamTimeout?: number

                                                                          An incoming stream must resolve within this number of seconds

                                                                          Default

                                                                          30000
                                                                           
                                                                          -
                                                                          maxInboundStreams?: number

                                                                          This is the maximum number of concurrent inbound bitswap streams that are +

                                                                          maxInboundStreams?: number

                                                                          This is the maximum number of concurrent inbound bitswap streams that are allowed

                                                                          Default

                                                                          32
                                                                           
                                                                          -
                                                                          maxIncomingMessageSize?: number

                                                                          The maximum size in bytes of an incoming message that we will process.

                                                                          +
                                                                          maxIncomingMessageSize?: number

                                                                          The maximum size in bytes of an incoming message that we will process.

                                                                          Messages larger than this will cause the incoming stream to be reset.

                                                                          Defaults to maxOutgoingMessageSize

                                                                          Default

                                                                          2097152
                                                                           
                                                                          -
                                                                          maxOutboundStreams?: number

                                                                          This is the maximum number of concurrent outbound bitswap streams that are +

                                                                          maxOutboundStreams?: number

                                                                          This is the maximum number of concurrent outbound bitswap streams that are allowed

                                                                          Default

                                                                          128
                                                                           
                                                                          -
                                                                          maxOutgoingMessageSize?: number

                                                                          The maximum size in bytes of a message that we will send. If a message is +

                                                                          maxOutgoingMessageSize?: number

                                                                          The maximum size in bytes of a message that we will send. If a message is larger than this (due to lots of blocks or wantlist entries) it will be broken up into several smaller messages that are under this size.

                                                                          maxSizeReplaceHasWithBlock?: number

                                                                          If the client sends a want-have, and we have the corresponding block, we +

                                                                          maxSizeReplaceHasWithBlock?: number

                                                                          If the client sends a want-have, and we have the corresponding block, we check the size of the block and if it's small enough we send the block itself, rather than sending a HAVE.

                                                                          This defines the maximum size up to which we replace a HAVE with a block.

                                                                          Default

                                                                          1024
                                                                           
                                                                          -
                                                                          messageSendConcurrency?: number

                                                                          When sending want list updates to peers, how many messages to send at once

                                                                          +
                                                                          messageSendConcurrency?: number

                                                                          When sending want list updates to peers, how many messages to send at once

                                                                          Default

                                                                          50
                                                                           
                                                                          -
                                                                          protocol?: string

                                                                          The protocol that we speak

                                                                          +
                                                                          protocol?: string

                                                                          The protocol that we speak

                                                                          Default

                                                                          '/ipfs/bitswap/1.2.0'
                                                                           
                                                                          -
                                                                          runOnTransientConnections?: boolean

                                                                          Whether to run on transient (e.g. time/data limited) connections

                                                                          +
                                                                          runOnTransientConnections?: boolean

                                                                          Whether to run on transient (e.g. time/data limited) connections

                                                                          Default

                                                                          false
                                                                           
                                                                          -
                                                                          sendBlocksConcurrency?: number

                                                                          When sending blocks to peers, how many messages to send at once

                                                                          +
                                                                          sendBlocksConcurrency?: number

                                                                          When sending blocks to peers, how many messages to send at once

                                                                          Default

                                                                          50
                                                                           
                                                                          -
                                                                          sendBlocksDebounce?: number

                                                                          When a block is added to the blockstore and we are about to send that block +

                                                                          sendBlocksDebounce?: number

                                                                          When a block is added to the blockstore and we are about to send that block to peers who have it in their wantlist, wait this many milliseconds before queueing the send job in case more blocks are added that they want

                                                                          Default

                                                                          10
                                                                           
                                                                          -
                                                                          sendBlocksTimeout?: number

                                                                          When sending blocks to peers, timeout after this many milliseconds. +

                                                                          sendBlocksTimeout?: number

                                                                          When sending blocks to peers, timeout after this many milliseconds. This is useful for preventing slow/large peer-connections from consuming your bandwidth/streams.

                                                                          Default

                                                                          10000
                                                                           
                                                                          -
                                                                          \ No newline at end of file +
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.MultihashHasherLoader.html b/interfaces/_helia_bitswap.MultihashHasherLoader.html index b1dff1157..584771bff 100644 --- a/interfaces/_helia_bitswap.MultihashHasherLoader.html +++ b/interfaces/_helia_bitswap.MultihashHasherLoader.html @@ -1,2 +1,2 @@ -MultihashHasherLoader | Helia

                                                                          Interface MultihashHasherLoader

                                                                          interface MultihashHasherLoader {
                                                                              getHasher(codeOrName): Promise<MultihashHasher<number>>;
                                                                          }

                                                                          Methods

                                                                          Methods

                                                                          \ No newline at end of file +MultihashHasherLoader | Helia

                                                                          Interface MultihashHasherLoader

                                                                          interface MultihashHasherLoader {
                                                                              getHasher(codeOrName): Promise<MultihashHasher<number>>;
                                                                          }

                                                                          Methods

                                                                          Methods

                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.WantListEntry.html b/interfaces/_helia_bitswap.WantListEntry.html index 780b82c78..21d1d12e1 100644 --- a/interfaces/_helia_bitswap.WantListEntry.html +++ b/interfaces/_helia_bitswap.WantListEntry.html @@ -1,4 +1,4 @@ -WantListEntry | Helia

                                                                          Interface WantListEntry

                                                                          interface WantListEntry {
                                                                              cid: CID<unknown, number, number, Version>;
                                                                              priority: number;
                                                                              wantType: WantType;
                                                                          }

                                                                          Properties

                                                                          cid +WantListEntry | Helia

                                                                          Interface WantListEntry

                                                                          interface WantListEntry {
                                                                              cid: CID<unknown, number, number, Version>;
                                                                              priority: number;
                                                                              wantType: WantType;
                                                                          }

                                                                          Properties

                                                                          Properties

                                                                          cid: CID<unknown, number, number, Version>
                                                                          priority: number
                                                                          wantType: WantType
                                                                          \ No newline at end of file +

                                                                          Properties

                                                                          cid: CID<unknown, number, number, Version>
                                                                          priority: number
                                                                          wantType: WantType
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_car.Car.html b/interfaces/_helia_car.Car.html index 7df2ea130..efd96a5db 100644 --- a/interfaces/_helia_car.Car.html +++ b/interfaces/_helia_car.Car.html @@ -1,15 +1,15 @@ Car | Helia

                                                                          Interface Car

                                                                          The Car interface provides operations for importing and exporting Car files from Helia's underlying blockstore.

                                                                          -
                                                                          interface Car {
                                                                              export(root, writer, options?): Promise<void>;
                                                                              import(reader, options?): Promise<void>;
                                                                              stream(root, options?): AsyncGenerator<Uint8Array, any, unknown>;
                                                                          }

                                                                          Methods

                                                                          interface Car {
                                                                              export(root, writer, options?): Promise<void>;
                                                                              import(reader, options?): Promise<void>;
                                                                              stream(root, options?): AsyncGenerator<Uint8Array, any, unknown>;
                                                                          }

                                                                          Methods

                                                                          • Store all blocks that make up one or more DAGs in a car file.

                                                                            Parameters

                                                                            Returns Promise<void>

                                                                            Example

                                                                            import fs from 'node:fs'
                                                                            import { Readable } from 'stream'
                                                                            import { createHelia } from 'helia'
                                                                            import { car } from '@helia/car
                                                                            import { CID } from 'multiformats/cid'
                                                                            import pEvent from 'p-event'

                                                                            const helia = await createHelia()
                                                                            const cid = CID.parse('QmFoo...')

                                                                            const c = car(helia)

                                                                            const byteStream = await c.export(cid)
                                                                            const output = fs.createWriteStream('example.car')
                                                                            const eventPromise = pEvent(output, 'end')
                                                                            Readable.from(byteStream).pipe(output)

                                                                            await eventPromise
                                                                            -
                                                                          • Add all blocks in the passed CarReader to the blockstore.

                                                                            +
                                                                          • Add all blocks in the passed CarReader to the blockstore.

                                                                            Parameters

                                                                            Returns Promise<void>

                                                                            Example

                                                                            import fs from 'node:fs'
                                                                            import { createHelia } from 'helia'
                                                                            import { car } from '@helia/car
                                                                            import { CarReader } from '@ipld/car'

                                                                            const helia = await createHelia()

                                                                            const inStream = fs.createReadStream('example.car')
                                                                            const reader = await CarReader.fromIterable(inStream)

                                                                            const c = car(helia)
                                                                            await c.import(reader)
                                                                            -
                                                                          \ No newline at end of file +
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_car.CarComponents.html b/interfaces/_helia_car.CarComponents.html index 2985e990a..e262a7da1 100644 --- a/interfaces/_helia_car.CarComponents.html +++ b/interfaces/_helia_car.CarComponents.html @@ -1,3 +1,3 @@ -CarComponents | Helia

                                                                          Interface CarComponents

                                                                          interface CarComponents {
                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                              dagWalkers: Record<number, DAGWalker>;
                                                                          }

                                                                          Properties

                                                                          blockstore +CarComponents | Helia

                                                                          Interface CarComponents

                                                                          interface CarComponents {
                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                              dagWalkers: Record<number, DAGWalker>;
                                                                          }

                                                                          Properties

                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          dagWalkers: Record<number, DAGWalker>
                                                                                          \ No newline at end of file +

                                                                                          Properties

                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          dagWalkers: Record<number, DAGWalker>
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.AddOptions.html b/interfaces/_helia_dag_cbor.AddOptions.html index 079f7ee9f..ce0c9078d 100644 --- a/interfaces/_helia_dag_cbor.AddOptions.html +++ b/interfaces/_helia_dag_cbor.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | Helia

                                                                                                          Interface AddOptions

                                                                                                          interface AddOptions {
                                                                                                              hasher: MultihashHasher<number>;
                                                                                                              onProgress?: ((evt) => void);
                                                                                                              signal?: AbortSignal;
                                                                                                          }

                                                                                                          Hierarchy

                                                                                                          Properties

                                                                                                          hasher +AddOptions | Helia

                                                                                                          Interface AddOptions

                                                                                                          interface AddOptions {
                                                                                                              hasher: MultihashHasher<number>;
                                                                                                              onProgress?: ((evt) => void);
                                                                                                              signal?: AbortSignal;
                                                                                                          }

                                                                                                          Hierarchy

                                                                                                          Properties

                                                                                                          hasher: MultihashHasher<number>
                                                                                                          onProgress?: ((evt) => void)

                                                                                                          Type declaration

                                                                                                          signal?: AbortSignal
                                                                                                          \ No newline at end of file +

                                                                                                          Properties

                                                                                                          hasher: MultihashHasher<number>
                                                                                                          onProgress?: ((evt) => void)

                                                                                                          Type declaration

                                                                                                          signal?: AbortSignal
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.DAGCBOR.html b/interfaces/_helia_dag_cbor.DAGCBOR.html index 8e47c48cd..a07b6db14 100644 --- a/interfaces/_helia_dag_cbor.DAGCBOR.html +++ b/interfaces/_helia_dag_cbor.DAGCBOR.html @@ -1,13 +1,13 @@ DAGCBOR | Helia

                                                                                                          The JSON interface provides a simple and intuitive way to add/get objects with your Helia node and is a great place to start learning about IPFS.

                                                                                                          -
                                                                                                          interface DAGCBOR {
                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                          }

                                                                                                          Methods

                                                                                                          add +
                                                                                                          interface DAGCBOR {
                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                          }

                                                                                                          Methods

                                                                                                          Methods

                                                                                                          • Add an object to your Helia node and get a CID that refers to the block the object has been stored as.

                                                                                                            Parameters

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

                                                                                                            Example

                                                                                                            import { dagCbor } from '@helia/dag-cbor'

                                                                                                            const d = dagCbor(helia)
                                                                                                            const cid = await d.add({ hello: 'world' })

                                                                                                            console.info(cid)
                                                                                                            // CID(bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae)
                                                                                                            -
                                                                                                          • Get an object from your Helia node, either previously added to it or to another node on the network.

                                                                                                            Type Parameters

                                                                                                            • T

                                                                                                            Parameters

                                                                                                            Returns Promise<T>

                                                                                                            Example

                                                                                                            import { dagCbor } from '@helia/dag-cbor'
                                                                                                            import { CID } from 'multiformats/cid'

                                                                                                            const d = dagCbor(helia)
                                                                                                            const cid = CID.parse('bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae')
                                                                                                            const obj = await d.get(cid)

                                                                                                            console.info(obj)
                                                                                                            // { hello: 'world' }
                                                                                                            -
                                                                                                          \ No newline at end of file +
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.DAGCBORComponents.html b/interfaces/_helia_dag_cbor.DAGCBORComponents.html index 9a5b61679..a70df8570 100644 --- a/interfaces/_helia_dag_cbor.DAGCBORComponents.html +++ b/interfaces/_helia_dag_cbor.DAGCBORComponents.html @@ -1,2 +1,2 @@ -DAGCBORComponents | Helia

                                                                                                          Interface DAGCBORComponents

                                                                                                          interface DAGCBORComponents {
                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                          }

                                                                                                          Properties

                                                                                                          Properties

                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  Type declaration

                                                                                                                    Type declaration

                                                                                                                      Type declaration

                                                                                                                        Type declaration

                                                                                                                          \ No newline at end of file +DAGCBORComponents | Helia

                                                                                                                          Interface DAGCBORComponents

                                                                                                                          interface DAGCBORComponents {
                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                          }

                                                                                                                          Properties

                                                                                                                          Properties

                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                          Type declaration

                                                                                                                            Type declaration

                                                                                                                              Type declaration

                                                                                                                                Type declaration

                                                                                                                                  Type declaration

                                                                                                                                    Type declaration

                                                                                                                                      Type declaration

                                                                                                                                        Type declaration

                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.GetOptions.html b/interfaces/_helia_dag_cbor.GetOptions.html index d39c2789c..93a3fc349 100644 --- a/interfaces/_helia_dag_cbor.GetOptions.html +++ b/interfaces/_helia_dag_cbor.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | Helia

                                                                                                                                          Interface GetOptions

                                                                                                                                          interface GetOptions {
                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                              signal?: AbortSignal;
                                                                                                                                          }

                                                                                                                                          Hierarchy

                                                                                                                                          Properties

                                                                                                                                          codec +GetOptions | Helia

                                                                                                                                          Interface GetOptions

                                                                                                                                          interface GetOptions {
                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                              signal?: AbortSignal;
                                                                                                                                          }

                                                                                                                                          Hierarchy

                                                                                                                                          Properties

                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          signal?: AbortSignal
                                                                                                                                          \ No newline at end of file +

                                                                                                                                          Properties

                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          signal?: AbortSignal
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.AddOptions.html b/interfaces/_helia_dag_json.AddOptions.html index 25b7f051d..da57083b6 100644 --- a/interfaces/_helia_dag_json.AddOptions.html +++ b/interfaces/_helia_dag_json.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | Helia

                                                                                                                                          Interface AddOptions

                                                                                                                                          interface AddOptions {
                                                                                                                                              hasher: MultihashHasher<number>;
                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                              signal?: AbortSignal;
                                                                                                                                          }

                                                                                                                                          Hierarchy

                                                                                                                                          Properties

                                                                                                                                          hasher +AddOptions | Helia

                                                                                                                                          Interface AddOptions

                                                                                                                                          interface AddOptions {
                                                                                                                                              hasher: MultihashHasher<number>;
                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                              signal?: AbortSignal;
                                                                                                                                          }

                                                                                                                                          Hierarchy

                                                                                                                                          Properties

                                                                                                                                          hasher: MultihashHasher<number>
                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          signal?: AbortSignal
                                                                                                                                          \ No newline at end of file +

                                                                                                                                          Properties

                                                                                                                                          hasher: MultihashHasher<number>
                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          signal?: AbortSignal
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.DAGJSON.html b/interfaces/_helia_dag_json.DAGJSON.html index 6d7d46d8c..325e6961b 100644 --- a/interfaces/_helia_dag_json.DAGJSON.html +++ b/interfaces/_helia_dag_json.DAGJSON.html @@ -1,13 +1,13 @@ DAGJSON | Helia

                                                                                                                                          The JSON interface provides a simple and intuitive way to add/get objects with your Helia node and is a great place to start learning about IPFS.

                                                                                                                                          -
                                                                                                                                          interface DAGJSON {
                                                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                                                          }

                                                                                                                                          Methods

                                                                                                                                          add +
                                                                                                                                          interface DAGJSON {
                                                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                                                          }

                                                                                                                                          Methods

                                                                                                                                          Methods

                                                                                                                                          • Add an object to your Helia node and get a CID that refers to the block the object has been stored as.

                                                                                                                                            Parameters

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

                                                                                                                                            Example

                                                                                                                                            import { json } from '@helia/dag-json'

                                                                                                                                            const j = json(helia)
                                                                                                                                            const cid = await str.add({ hello: 'world' })

                                                                                                                                            console.info(cid)
                                                                                                                                            // CID(baguqeerasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
                                                                                                                                            -
                                                                                                                                          • Get an object from your Helia node, either previously added to it or to another node on the network.

                                                                                                                                            Type Parameters

                                                                                                                                            • T

                                                                                                                                            Parameters

                                                                                                                                            Returns Promise<T>

                                                                                                                                            Example

                                                                                                                                            import { json } from '@helia/dag-json'
                                                                                                                                            import { CID } from 'multiformats/cid'

                                                                                                                                            const j = json(helia)
                                                                                                                                            const cid = CID.parse('baguqeerasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
                                                                                                                                            const obj = await j.get(cid)

                                                                                                                                            console.info(obj)
                                                                                                                                            // { hello: 'world' }
                                                                                                                                            -
                                                                                                                                          \ No newline at end of file +
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.DAGJSONComponents.html b/interfaces/_helia_dag_json.DAGJSONComponents.html index dc1bb7d87..0b8a26f0d 100644 --- a/interfaces/_helia_dag_json.DAGJSONComponents.html +++ b/interfaces/_helia_dag_json.DAGJSONComponents.html @@ -1,2 +1,2 @@ -DAGJSONComponents | Helia

                                                                                                                                          Interface DAGJSONComponents

                                                                                                                                          interface DAGJSONComponents {
                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                          }

                                                                                                                                          Properties

                                                                                                                                          Properties

                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                          Type declaration

                                                                                                                                            Type declaration

                                                                                                                                              Type declaration

                                                                                                                                                Type declaration

                                                                                                                                                  Type declaration

                                                                                                                                                    Type declaration

                                                                                                                                                      Type declaration

                                                                                                                                                        Type declaration

                                                                                                                                                          \ No newline at end of file +DAGJSONComponents | Helia

                                                                                                                                                          Interface DAGJSONComponents

                                                                                                                                                          interface DAGJSONComponents {
                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                          }

                                                                                                                                                          Properties

                                                                                                                                                          Properties

                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                          Type declaration

                                                                                                                                                            Type declaration

                                                                                                                                                              Type declaration

                                                                                                                                                                Type declaration

                                                                                                                                                                  Type declaration

                                                                                                                                                                    Type declaration

                                                                                                                                                                      Type declaration

                                                                                                                                                                        Type declaration

                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.GetOptions.html b/interfaces/_helia_dag_json.GetOptions.html index edbe9bfc7..6a561866d 100644 --- a/interfaces/_helia_dag_json.GetOptions.html +++ b/interfaces/_helia_dag_json.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | Helia

                                                                                                                                                                          Interface GetOptions

                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          codec +GetOptions | Helia

                                                                                                                                                                          Interface GetOptions

                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Properties

                                                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_http.HeliaHTTPInit.html b/interfaces/_helia_http.HeliaHTTPInit.html index f43812aea..f4ba2f888 100644 --- a/interfaces/_helia_http.HeliaHTTPInit.html +++ b/interfaces/_helia_http.HeliaHTTPInit.html @@ -1,5 +1,5 @@ HeliaHTTPInit | Helia

                                                                                                                                                                          Interface HeliaHTTPInit

                                                                                                                                                                          Options used to create a Helia node.

                                                                                                                                                                          -
                                                                                                                                                                          interface HeliaHTTPInit {
                                                                                                                                                                              blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              components?: Record<string, any>;
                                                                                                                                                                              dagWalkers?: DAGWalker[];
                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              dns?: DNS;
                                                                                                                                                                              hashers?: MultihashHasher<number>[];
                                                                                                                                                                              holdGcLock?: boolean;
                                                                                                                                                                              logger?: ComponentLogger;
                                                                                                                                                                              metrics?: Metrics;
                                                                                                                                                                              providerLookupConcurrency?: number;
                                                                                                                                                                              routers?: Partial<Routing>[];
                                                                                                                                                                              start?: boolean;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                          Properties

                                                                                                                                                                          interface HeliaHTTPInit {
                                                                                                                                                                              blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              components?: Record<string, any>;
                                                                                                                                                                              dagWalkers?: DAGWalker[];
                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              dns?: DNS;
                                                                                                                                                                              hashers?: MultihashHasher<number>[];
                                                                                                                                                                              holdGcLock?: boolean;
                                                                                                                                                                              logger?: ComponentLogger;
                                                                                                                                                                              metrics?: Metrics;
                                                                                                                                                                              providerLookupConcurrency?: number;
                                                                                                                                                                              routers?: Partial<Routing>[];
                                                                                                                                                                              start?: boolean;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                          Properties

                                                                                                                                                                          routers?: Partial<Routing>[]

                                                                                                                                                                          Routers perform operations such as looking up content providers, information about network peers or getting/putting records.

                                                                                                                                                                          start?: boolean

                                                                                                                                                                          Whether to start the Helia node

                                                                                                                                                                          -
                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html b/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html index e1d3e9fec..64a3cb69f 100644 --- a/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html +++ b/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html @@ -1,3 +1,3 @@ -BlockAnnounceOptions | Helia

                                                                                                                                                                          Interface BlockAnnounceOptions<ProgressEvents>

                                                                                                                                                                          interface BlockAnnounceOptions<ProgressEvents> {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress? +BlockAnnounceOptions | Helia

                                                                                                                                                                          Interface BlockAnnounceOptions<ProgressEvents>

                                                                                                                                                                          interface BlockAnnounceOptions<ProgressEvents> {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockBroker.html b/interfaces/_helia_interface.blocks.BlockBroker.html index b4fa49891..1e523a798 100644 --- a/interfaces/_helia_interface.blocks.BlockBroker.html +++ b/interfaces/_helia_interface.blocks.BlockBroker.html @@ -1,7 +1,7 @@ -BlockBroker | Helia

                                                                                                                                                                          Interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>

                                                                                                                                                                          interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents> {
                                                                                                                                                                              announce?(cid, block, options?): Promise<void>;
                                                                                                                                                                              createSession?(options?): BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>;
                                                                                                                                                                              retrieve?(cid, options?): Promise<Uint8Array>;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Methods

                                                                                                                                                                          announce? +BlockBroker | Helia

                                                                                                                                                                          Interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>

                                                                                                                                                                          interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents> {
                                                                                                                                                                              announce?(cid, block, options?): Promise<void>;
                                                                                                                                                                              createSession?(options?): BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>;
                                                                                                                                                                              retrieve?(cid, options?): Promise<Uint8Array>;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Methods

                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html b/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html index 622c51e1f..4b032cc74 100644 --- a/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html +++ b/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html @@ -1,8 +1,8 @@ -BlockRetrievalOptions | Helia

                                                                                                                                                                          Interface BlockRetrievalOptions<ProgressEvents>

                                                                                                                                                                          interface BlockRetrievalOptions<ProgressEvents> {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                              validateFn?(block): Promise<void>;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress? +BlockRetrievalOptions | Helia

                                                                                                                                                                          Interface BlockRetrievalOptions<ProgressEvents>

                                                                                                                                                                          interface BlockRetrievalOptions<ProgressEvents> {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                              validateFn?(block): Promise<void>;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          Methods

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Methods

                                                                                                                                                                          • A function that blockBrokers should call prior to returning a block to ensure it can maintain control of the block request flow. e.g. TrustedGatewayBlockBroker will use this to ensure that the block is valid from one of the gateways before assuming it's work is done. If the block is not valid, it should try another gateway and WILL consider the gateway that returned the invalid blocks completely unreliable.

                                                                                                                                                                            -

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.Blocks.html b/interfaces/_helia_interface.blocks.Blocks.html index 4c1fc65d1..69b2b210f 100644 --- a/interfaces/_helia_interface.blocks.Blocks.html +++ b/interfaces/_helia_interface.blocks.Blocks.html @@ -1,4 +1,4 @@ -Blocks | Helia
                                                                                                                                                                          interface Blocks {
                                                                                                                                                                              createSession(root, options?): SessionBlockstore;
                                                                                                                                                                              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>>;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Methods

                                                                                                                                                                          createSession +Blocks | Helia
                                                                                                                                                                          interface Blocks {
                                                                                                                                                                              createSession(root, options?): SessionBlockstore;
                                                                                                                                                                              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>>;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Methods

                                                                                                                                                                          Methods

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            +

                                                                                                                                                                          Methods

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns Await<void>

                                                                                                                                                                            Example

                                                                                                                                                                            await store.delete(new Key('awesome'))
                                                                                                                                                                            console.log('deleted awesome content :(')
                                                                                                                                                                          • Remove values for the passed keys

                                                                                                                                                                            diff --git a/interfaces/_helia_interface.blocks.CreateSessionOptions.html b/interfaces/_helia_interface.blocks.CreateSessionOptions.html index 97423fd7c..51b7e10ad 100644 --- a/interfaces/_helia_interface.blocks.CreateSessionOptions.html +++ b/interfaces/_helia_interface.blocks.CreateSessionOptions.html @@ -1,14 +1,14 @@ -CreateSessionOptions | Helia

                                                                                                                                                                            Interface CreateSessionOptions<ProgressEvents>

                                                                                                                                                                            interface CreateSessionOptions<ProgressEvents> {
                                                                                                                                                                                maxProviders?: number;
                                                                                                                                                                                minProviders?: number;
                                                                                                                                                                                onProgress?: ((evt) => void);
                                                                                                                                                                                signal?: AbortSignal;
                                                                                                                                                                            }

                                                                                                                                                                            Type Parameters

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            Properties

                                                                                                                                                                            maxProviders? +CreateSessionOptions | Helia

                                                                                                                                                                            Interface CreateSessionOptions<ProgressEvents>

                                                                                                                                                                            interface CreateSessionOptions<ProgressEvents> {
                                                                                                                                                                                maxProviders?: number;
                                                                                                                                                                                minProviders?: number;
                                                                                                                                                                                onProgress?: ((evt) => void);
                                                                                                                                                                                signal?: AbortSignal;
                                                                                                                                                                            }

                                                                                                                                                                            Type Parameters

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            Properties

                                                                                                                                                                            maxProviders?: number

                                                                                                                                                                            The maximum number of providers for the root CID to be added to a session.

                                                                                                                                                                            Default

                                                                                                                                                                            5
                                                                                                                                                                             
                                                                                                                                                                            -
                                                                                                                                                                            minProviders?: number

                                                                                                                                                                            The minimum number of providers for the root CID that are required for +

                                                                                                                                                                            minProviders?: number

                                                                                                                                                                            The minimum number of providers for the root CID that are required for successful session creation.

                                                                                                                                                                            The session will become usable once this many providers have been discovered, up to maxProviders providers will continue to be added.

                                                                                                                                                                            Default

                                                                                                                                                                            1
                                                                                                                                                                             
                                                                                                                                                                            -
                                                                                                                                                                            onProgress?: ((evt) => void)

                                                                                                                                                                            Type declaration

                                                                                                                                                                            signal?: AbortSignal
                                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                                            onProgress?: ((evt) => void)

                                                                                                                                                                            Type declaration

                                                                                                                                                                            signal?: AbortSignal
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.GetOfflineOptions.html b/interfaces/_helia_interface.blocks.GetOfflineOptions.html index 528211e70..136f7d359 100644 --- a/interfaces/_helia_interface.blocks.GetOfflineOptions.html +++ b/interfaces/_helia_interface.blocks.GetOfflineOptions.html @@ -1,5 +1,5 @@ -GetOfflineOptions | Helia
                                                                                                                                                                            interface GetOfflineOptions {
                                                                                                                                                                                offline?: boolean;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            offline? +GetOfflineOptions | Helia
                                                                                                                                                                            interface GetOfflineOptions {
                                                                                                                                                                                offline?: boolean;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            Properties

                                                                                                                                                                            offline?: boolean

                                                                                                                                                                            If true, do not attempt to fetch any missing blocks from the network

                                                                                                                                                                            Default

                                                                                                                                                                            false
                                                                                                                                                                             
                                                                                                                                                                            -
                                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.Pair.html b/interfaces/_helia_interface.blocks.Pair.html index ac1c9bec4..9f215ccf5 100644 --- a/interfaces/_helia_interface.blocks.Pair.html +++ b/interfaces/_helia_interface.blocks.Pair.html @@ -1,3 +1,3 @@ -Pair | Helia
                                                                                                                                                                            interface Pair {
                                                                                                                                                                                block: Uint8Array;
                                                                                                                                                                                cid: CID<unknown, number, number, Version>;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            block +Pair | Helia
                                                                                                                                                                            interface Pair {
                                                                                                                                                                                block: Uint8Array;
                                                                                                                                                                                cid: CID<unknown, number, number, Version>;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            Properties

                                                                                                                                                                            block: Uint8Array
                                                                                                                                                                            cid: CID<unknown, number, number, Version>
                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                            Properties

                                                                                                                                                                            block: Uint8Array
                                                                                                                                                                            cid: CID<unknown, number, number, Version>
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.SessionBlockstore.html b/interfaces/_helia_interface.blocks.SessionBlockstore.html index 315345bb4..1b8e53b01 100644 --- a/interfaces/_helia_interface.blocks.SessionBlockstore.html +++ b/interfaces/_helia_interface.blocks.SessionBlockstore.html @@ -3,7 +3,7 @@ root CID.

                                                                                                                                                                            Any blocks written to the blockstore as part of the session will propagate to the blockstore the session was created from.

                                                                                                                                                                            -
                                                                                                                                                                          interface SessionBlockstore {
                                                                                                                                                                              close(): void;
                                                                                                                                                                              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>>;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Methods

                                                                                                                                                                          interface SessionBlockstore {
                                                                                                                                                                              close(): void;
                                                                                                                                                                              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>>;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Methods

                                                                                                                                                                          close delete deleteMany get @@ -13,7 +13,7 @@ put putMany

                                                                                                                                                                          Methods

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns Await<void>

                                                                                                                                                                            Example

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

                                                                                                                                                                          Properties

                                                                                                                                                                          codec: number

                                                                                                                                                                          Methods

                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.index.GCOptions.html b/interfaces/_helia_interface.index.GCOptions.html index 323c4160e..760b14143 100644 --- a/interfaces/_helia_interface.index.GCOptions.html +++ b/interfaces/_helia_interface.index.GCOptions.html @@ -1,3 +1,3 @@ -GCOptions | Helia
                                                                                                                                                                          interface GCOptions {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress? +GCOptions | Helia
                                                                                                                                                                          interface GCOptions {
                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                            • (evt): void
                                                                                                                                                                            • Parameters

                                                                                                                                                                              Returns void

                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.index.Helia.html b/interfaces/_helia_interface.index.Helia.html index 7ca254424..19232e8e2 100644 --- a/interfaces/_helia_interface.index.Helia.html +++ b/interfaces/_helia_interface.index.Helia.html @@ -1,5 +1,5 @@ Helia | Helia

                                                                                                                                                                          The API presented by a Helia node

                                                                                                                                                                          -
                                                                                                                                                                          interface Helia {
                                                                                                                                                                              blockstore: Blocks;
                                                                                                                                                                              dagWalkers: Record<number, DAGWalker>;
                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              dns: DNS;
                                                                                                                                                                              hashers: Record<number, MultihashHasher<number>>;
                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                              metrics?: Metrics;
                                                                                                                                                                              pins: Pins;
                                                                                                                                                                              routing: Routing;
                                                                                                                                                                              gc(options?): Promise<void>;
                                                                                                                                                                              start(): Promise<void>;
                                                                                                                                                                              stop(): Promise<void>;
                                                                                                                                                                          }

                                                                                                                                                                          Properties

                                                                                                                                                                          interface Helia {
                                                                                                                                                                              blockstore: Blocks;
                                                                                                                                                                              dagWalkers: Record<number, DAGWalker>;
                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                              dns: DNS;
                                                                                                                                                                              hashers: Record<number, MultihashHasher<number>>;
                                                                                                                                                                              logger: ComponentLogger;
                                                                                                                                                                              metrics?: Metrics;
                                                                                                                                                                              pins: Pins;
                                                                                                                                                                              routing: Routing;
                                                                                                                                                                              gc(options?): Promise<void>;
                                                                                                                                                                              start(): Promise<void>;
                                                                                                                                                                              stop(): Promise<void>;
                                                                                                                                                                          }

                                                                                                                                                                          Properties

                                                                                                                                                                          Properties

                                                                                                                                                                          blockstore: Blocks

                                                                                                                                                                          Where the blocks are stored

                                                                                                                                                                          -
                                                                                                                                                                          dagWalkers: Record<number, DAGWalker>

                                                                                                                                                                          DAGWalkers are codec-specific implementations that know how to yield all +

                                                                                                                                                                          dagWalkers: Record<number, DAGWalker>

                                                                                                                                                                          DAGWalkers are codec-specific implementations that know how to yield all CIDs contained within a block that corresponds to that codec.

                                                                                                                                                                          -
                                                                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                          A key/value store

                                                                                                                                                                          -

                                                                                                                                                                          Type declaration

                                                                                                                                                                            Type declaration

                                                                                                                                                                              Type declaration

                                                                                                                                                                                Type declaration

                                                                                                                                                                                  Type declaration

                                                                                                                                                                                    Type declaration

                                                                                                                                                                                      Type declaration

                                                                                                                                                                                        Type declaration

                                                                                                                                                                                          Type declaration

                                                                                                                                                                                            Type declaration

                                                                                                                                                                                              dns: DNS

                                                                                                                                                                                              The DNS property can be used to perform lookups of various record types and +

                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                              A key/value store

                                                                                                                                                                                              +

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                  dns: DNS

                                                                                                                                                                                                                  The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>

                                                                                                                                                                                                                  Hashers can be used to hash a piece of data with the specified hashing +

                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>

                                                                                                                                                                                                                  Hashers can be used to hash a piece of data with the specified hashing algorithm.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  A logging component that can be reused by consumers

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  metrics?: Metrics

                                                                                                                                                                                                                  A metrics object that can be used to collected arbitrary stats about node +

                                                                                                                                                                                                                  A logging component that can be reused by consumers

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  metrics?: Metrics

                                                                                                                                                                                                                  A metrics object that can be used to collected arbitrary stats about node usage.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  pins: Pins

                                                                                                                                                                                                                  Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  routing: Routing

                                                                                                                                                                                                                  The routing component allows performing operations such as looking up +

                                                                                                                                                                                                                  pins: Pins

                                                                                                                                                                                                                  Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  routing: Routing

                                                                                                                                                                                                                  The routing component allows performing operations such as looking up content providers, information about peers, etc.

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.index.Provider.html b/interfaces/_helia_interface.index.Provider.html index b46db2e9a..a0b162ea7 100644 --- a/interfaces/_helia_interface.index.Provider.html +++ b/interfaces/_helia_interface.index.Provider.html @@ -1,5 +1,5 @@ Provider | Helia

                                                                                                                                                                                                                  A provider can supply the content for a CID

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface Provider {
                                                                                                                                                                                                                      id: PeerId;
                                                                                                                                                                                                                      multiaddrs: Multiaddr[];
                                                                                                                                                                                                                      protocols?: string[];
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  id +
                                                                                                                                                                                                                  interface Provider {
                                                                                                                                                                                                                      id: PeerId;
                                                                                                                                                                                                                      multiaddrs: Multiaddr[];
                                                                                                                                                                                                                      protocols?: string[];
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  id: PeerId

                                                                                                                                                                                                                  The identifier of the remote peer

                                                                                                                                                                                                                  @@ -13,4 +13,4 @@
                                                                                                                                                                                                                • transport-ipfs-gateway-http
                                                                                                                                                                                                                • transport-bitswap
                                                                                                                                                                                                                • -
                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.index.Routing.html b/interfaces/_helia_interface.index.Routing.html index d5db132f8..7d8511baa 100644 --- a/interfaces/_helia_interface.index.Routing.html +++ b/interfaces/_helia_interface.index.Routing.html @@ -1,4 +1,4 @@ -Routing | Helia
                                                                                                                                                                                                                  interface Routing {
                                                                                                                                                                                                                      findPeer(peerId, options?): Promise<PeerInfo>;
                                                                                                                                                                                                                      findProviders(cid, options?): AsyncIterable<Provider>;
                                                                                                                                                                                                                      get(key, options?): Promise<Uint8Array>;
                                                                                                                                                                                                                      getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                                                                                                                                                                                                                      provide(cid, options?): Promise<void>;
                                                                                                                                                                                                                      put(key, value, options?): Promise<void>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  findPeer +Routing | Helia
                                                                                                                                                                                                                  interface Routing {
                                                                                                                                                                                                                      findPeer(peerId, options?): Promise<PeerInfo>;
                                                                                                                                                                                                                      findProviders(cid, options?): AsyncIterable<Provider>;
                                                                                                                                                                                                                      get(key, options?): Promise<Uint8Array>;
                                                                                                                                                                                                                      getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                                                                                                                                                                                                                      provide(cid, options?): Promise<void>;
                                                                                                                                                                                                                      put(key, value, options?): Promise<void>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  • Find the providers of the passed CID.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns AsyncIterable<Provider>

                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                    // Iterate over the providers found for the given cid
                                                                                                                                                                                                                    for await (const provider of contentRouting.findProviders(cid)) {
                                                                                                                                                                                                                    console.log(provider.id, provider.multiaddrs)
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns AsyncIterable<PeerInfo>

                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                    // Iterate over the closest peers found for the given key
                                                                                                                                                                                                                    for await (const peer of peerRouting.getClosestPeers(key)) {
                                                                                                                                                                                                                    console.log(peer.id, peer.multiaddrs)
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • The implementation of this method should ensure that network peers know the caller can provide content that corresponds to the passed CID.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                    // ...
                                                                                                                                                                                                                    await contentRouting.provide(cid)
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Puts a value corresponding to the passed key in a way that can later be retrieved by another network peer using the get method.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                    // ...
                                                                                                                                                                                                                    const key = '/key'
                                                                                                                                                                                                                    const value = uint8ArrayFromString('oh hello there')

                                                                                                                                                                                                                    await contentRouting.put(key, value)
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.index.RoutingOptions.html b/interfaces/_helia_interface.index.RoutingOptions.html index 4e480d482..c455d1f7b 100644 --- a/interfaces/_helia_interface.index.RoutingOptions.html +++ b/interfaces/_helia_interface.index.RoutingOptions.html @@ -2,7 +2,7 @@ controlling where the values are read from. Some implementations support a local cache that may be used in preference over network calls, for example when a record has a TTL.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface RoutingOptions {
                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                      useCache?: boolean;
                                                                                                                                                                                                                      useNetwork?: boolean;
                                                                                                                                                                                                                      validate?: boolean;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  interface RoutingOptions {
                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                      useCache?: boolean;
                                                                                                                                                                                                                      useNetwork?: boolean;
                                                                                                                                                                                                                      validate?: boolean;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                      • evt: any

                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  useCache?: boolean

                                                                                                                                                                                                                  Pass false to not use cached values

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  useNetwork?: boolean

                                                                                                                                                                                                                  Pass false to not use the network

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  useNetwork?: boolean

                                                                                                                                                                                                                  Pass false to not use the network

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  validate?: boolean

                                                                                                                                                                                                                  Pass false to not perform validation

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  validate?: boolean

                                                                                                                                                                                                                  Pass false to not perform validation

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.AddOptions.html b/interfaces/_helia_interface.pins.AddOptions.html index f6a2b02b4..8f886fb13 100644 --- a/interfaces/_helia_interface.pins.AddOptions.html +++ b/interfaces/_helia_interface.pins.AddOptions.html @@ -1,7 +1,7 @@ -AddOptions | Helia
                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                      depth?: number;
                                                                                                                                                                                                                      metadata?: Record<string, string | number | boolean>;
                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  depth? +AddOptions | Helia
                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                      depth?: number;
                                                                                                                                                                                                                      metadata?: Record<string, string | number | boolean>;
                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  depth?: number

                                                                                                                                                                                                                  How deeply to pin the DAG, defaults to Infinity

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  metadata?: Record<string, string | number | boolean>

                                                                                                                                                                                                                  Optional user-defined metadata to store with the pin

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                  metadata?: Record<string, string | number | boolean>

                                                                                                                                                                                                                  Optional user-defined metadata to store with the pin

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.IsPinnedOptions.html b/interfaces/_helia_interface.pins.IsPinnedOptions.html index b9d77f1e9..607cdacc9 100644 --- a/interfaces/_helia_interface.pins.IsPinnedOptions.html +++ b/interfaces/_helia_interface.pins.IsPinnedOptions.html @@ -1,2 +1,2 @@ -IsPinnedOptions | Helia
                                                                                                                                                                                                                  interface IsPinnedOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal? +IsPinnedOptions | Helia
                                                                                                                                                                                                                  interface IsPinnedOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.LsOptions.html b/interfaces/_helia_interface.pins.LsOptions.html index 4033d51ff..bec7d544e 100644 --- a/interfaces/_helia_interface.pins.LsOptions.html +++ b/interfaces/_helia_interface.pins.LsOptions.html @@ -1,3 +1,3 @@ -LsOptions | Helia
                                                                                                                                                                                                                  interface LsOptions {
                                                                                                                                                                                                                      cid?: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid? +LsOptions | Helia
                                                                                                                                                                                                                  interface LsOptions {
                                                                                                                                                                                                                      cid?: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid?: CID<unknown, number, number, Version>
                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid?: CID<unknown, number, number, Version>
                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.Pin.html b/interfaces/_helia_interface.pins.Pin.html index 291fb007f..63845c45b 100644 --- a/interfaces/_helia_interface.pins.Pin.html +++ b/interfaces/_helia_interface.pins.Pin.html @@ -1,4 +1,4 @@ -Pin | Helia
                                                                                                                                                                                                                  interface Pin {
                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      depth: number;
                                                                                                                                                                                                                      metadata: Record<string, any>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid +Pin | Helia
                                                                                                                                                                                                                  interface Pin {
                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      depth: number;
                                                                                                                                                                                                                      metadata: Record<string, any>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>
                                                                                                                                                                                                                  depth: number
                                                                                                                                                                                                                  metadata: Record<string, any>
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>
                                                                                                                                                                                                                  depth: number
                                                                                                                                                                                                                  metadata: Record<string, any>
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.Pins.html b/interfaces/_helia_interface.pins.Pins.html index ddd55cf24..4a234932f 100644 --- a/interfaces/_helia_interface.pins.Pins.html +++ b/interfaces/_helia_interface.pins.Pins.html @@ -1,11 +1,11 @@ -Pins | Helia
                                                                                                                                                                                                                  interface Pins {
                                                                                                                                                                                                                      add(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                      isPinned(cid, options?): Promise<boolean>;
                                                                                                                                                                                                                      ls(options?): AsyncGenerator<Pin, void, undefined>;
                                                                                                                                                                                                                      rm(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  add +Pins | Helia
                                                                                                                                                                                                                  interface Pins {
                                                                                                                                                                                                                      add(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                      isPinned(cid, options?): Promise<boolean>;
                                                                                                                                                                                                                      ls(options?): AsyncGenerator<Pin, void, undefined>;
                                                                                                                                                                                                                      rm(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Returns AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>

                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.RmOptions.html b/interfaces/_helia_interface.pins.RmOptions.html index 304b2d64e..798073d6d 100644 --- a/interfaces/_helia_interface.pins.RmOptions.html +++ b/interfaces/_helia_interface.pins.RmOptions.html @@ -1,2 +1,2 @@ -RmOptions | Helia
                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal? +RmOptions | Helia
                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.DNSLinkResolveResult.html b/interfaces/_helia_ipns.index.DNSLinkResolveResult.html index 2904c47ac..4f925ca7c 100644 --- a/interfaces/_helia_ipns.index.DNSLinkResolveResult.html +++ b/interfaces/_helia_ipns.index.DNSLinkResolveResult.html @@ -1,9 +1,9 @@ -DNSLinkResolveResult | Helia

                                                                                                                                                                                                                  Interface DNSLinkResolveResult

                                                                                                                                                                                                                  interface DNSLinkResolveResult {
                                                                                                                                                                                                                      answer: Answer;
                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  answer +DNSLinkResolveResult | Helia

                                                                                                                                                                                                                  Interface DNSLinkResolveResult

                                                                                                                                                                                                                  interface DNSLinkResolveResult {
                                                                                                                                                                                                                      answer: Answer;
                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  answer: Answer

                                                                                                                                                                                                                  The resolved record

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                  The CID that was resolved

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                  Any path component that was part of the resolved record

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                  The CID that was resolved

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                  Any path component that was part of the resolved record

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  ""
                                                                                                                                                                                                                   
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNS.html b/interfaces/_helia_ipns.index.IPNS.html index 0b42ff65a..b83b5ba6a 100644 --- a/interfaces/_helia_ipns.index.IPNS.html +++ b/interfaces/_helia_ipns.index.IPNS.html @@ -1,11 +1,11 @@ -IPNS | Helia
                                                                                                                                                                                                                  interface IPNS {
                                                                                                                                                                                                                      publish(key, value, options?): Promise<IPNSRecord>;
                                                                                                                                                                                                                      republish(options?): void;
                                                                                                                                                                                                                      resolve(key, options?): Promise<IPNSResolveResult>;
                                                                                                                                                                                                                      resolveDNSLink(domain, options?): Promise<DNSLinkResolveResult>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  publish +IPNS | Helia
                                                                                                                                                                                                                  interface IPNS {
                                                                                                                                                                                                                      publish(key, value, options?): Promise<IPNSRecord>;
                                                                                                                                                                                                                      republish(options?): void;
                                                                                                                                                                                                                      resolve(key, options?): Promise<IPNSResolveResult>;
                                                                                                                                                                                                                      resolveDNSLink(domain, options?): Promise<DNSLinkResolveResult>;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Returns Promise<IPNSResolveResult>

                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSComponents.html b/interfaces/_helia_ipns.index.IPNSComponents.html index e301f3c7b..90314e7b7 100644 --- a/interfaces/_helia_ipns.index.IPNSComponents.html +++ b/interfaces/_helia_ipns.index.IPNSComponents.html @@ -1,5 +1,5 @@ -IPNSComponents | Helia

                                                                                                                                                                                                                  Interface IPNSComponents

                                                                                                                                                                                                                  interface IPNSComponents {
                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                      dns: DNS;
                                                                                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                                                                                      routing: Routing;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  datastore +IPNSComponents | Helia

                                                                                                                                                                                                                  Interface IPNSComponents

                                                                                                                                                                                                                  interface IPNSComponents {
                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                      dns: DNS;
                                                                                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                                                                                      routing: Routing;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                      dns: DNS
                                                                                                                                                                                                                                      routing: Routing
                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                          dns: DNS
                                                                                                                                                                                                                                                          routing: Routing
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSOptions.html b/interfaces/_helia_ipns.index.IPNSOptions.html index 4db56d930..63f1a9613 100644 --- a/interfaces/_helia_ipns.index.IPNSOptions.html +++ b/interfaces/_helia_ipns.index.IPNSOptions.html @@ -1,2 +1,2 @@ -IPNSOptions | Helia
                                                                                                                                                                                                                                                          interface IPNSOptions {
                                                                                                                                                                                                                                                              routers?: IPNSRouting[];
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          routers?: IPNSRouting[]
                                                                                                                                                                                                                                                          \ No newline at end of file +IPNSOptions | Helia
                                                                                                                                                                                                                                                          interface IPNSOptions {
                                                                                                                                                                                                                                                              routers?: IPNSRouting[];
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          routers?: IPNSRouting[]
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSResolveResult.html b/interfaces/_helia_ipns.index.IPNSResolveResult.html index 0c999217b..211f46107 100644 --- a/interfaces/_helia_ipns.index.IPNSResolveResult.html +++ b/interfaces/_helia_ipns.index.IPNSResolveResult.html @@ -1,9 +1,9 @@ -IPNSResolveResult | Helia

                                                                                                                                                                                                                                                          Interface IPNSResolveResult

                                                                                                                                                                                                                                                          interface IPNSResolveResult {
                                                                                                                                                                                                                                                              cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                              record: IPNSRecord;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid +IPNSResolveResult | Helia

                                                                                                                                                                                                                                                          Interface IPNSResolveResult

                                                                                                                                                                                                                                                          interface IPNSResolveResult {
                                                                                                                                                                                                                                                              cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                              record: IPNSRecord;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                                                          The CID that was resolved

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          ""
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          record: IPNSRecord

                                                                                                                                                                                                                                                          The resolved record

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          record: IPNSRecord

                                                                                                                                                                                                                                                          The resolved record

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.PublishOptions.html b/interfaces/_helia_ipns.index.PublishOptions.html index 983294978..440c77a08 100644 --- a/interfaces/_helia_ipns.index.PublishOptions.html +++ b/interfaces/_helia_ipns.index.PublishOptions.html @@ -1,10 +1,10 @@ -PublishOptions | Helia

                                                                                                                                                                                                                                                          Interface PublishOptions

                                                                                                                                                                                                                                                          interface PublishOptions {
                                                                                                                                                                                                                                                              lifetime?: number;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                              v1Compatible?: boolean;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          lifetime? +PublishOptions | Helia

                                                                                                                                                                                                                                                          Interface PublishOptions

                                                                                                                                                                                                                                                          interface PublishOptions {
                                                                                                                                                                                                                                                              lifetime?: number;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                              v1Compatible?: boolean;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          lifetime?: number

                                                                                                                                                                                                                                                          Time duration of the record in ms (default: 24hrs)

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Only publish to a local datastore (default: false)

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          v1Compatible?: boolean

                                                                                                                                                                                                                                                          By default a IPNS V1 and a V2 signature is added to every record. Pass +

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Only publish to a local datastore (default: false)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          v1Compatible?: boolean

                                                                                                                                                                                                                                                          By default a IPNS V1 and a V2 signature is added to every record. Pass false here to only add a V2 signature. (default: true)

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.RepublishOptions.html b/interfaces/_helia_ipns.index.RepublishOptions.html index 938f86ca2..eee14a499 100644 --- a/interfaces/_helia_ipns.index.RepublishOptions.html +++ b/interfaces/_helia_ipns.index.RepublishOptions.html @@ -1,5 +1,5 @@ -RepublishOptions | Helia

                                                                                                                                                                                                                                                          Interface RepublishOptions

                                                                                                                                                                                                                                                          interface RepublishOptions {
                                                                                                                                                                                                                                                              interval?: number;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          interval? +RepublishOptions | Helia

                                                                                                                                                                                                                                                          Interface RepublishOptions

                                                                                                                                                                                                                                                          interface RepublishOptions {
                                                                                                                                                                                                                                                              interval?: number;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          interval?: number

                                                                                                                                                                                                                                                          The republish interval in ms (default: 23hrs)

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html b/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html index 34e2024c7..72f94c0e8 100644 --- a/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html +++ b/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html @@ -1,4 +1,4 @@ -ResolveDNSLinkOptions | Helia

                                                                                                                                                                                                                                                          Interface ResolveDNSLinkOptions

                                                                                                                                                                                                                                                          interface ResolveDNSLinkOptions {
                                                                                                                                                                                                                                                              maxRecursiveDepth?: number;
                                                                                                                                                                                                                                                              nocache?: boolean;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          maxRecursiveDepth? +ResolveDNSLinkOptions | Helia

                                                                                                                                                                                                                                                          Interface ResolveDNSLinkOptions

                                                                                                                                                                                                                                                          interface ResolveDNSLinkOptions {
                                                                                                                                                                                                                                                              maxRecursiveDepth?: number;
                                                                                                                                                                                                                                                              nocache?: boolean;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          maxRecursiveDepth? nocache? offline? onProgress? @@ -7,10 +7,10 @@ how many times we will recursively resolve them.

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          32
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached DNS entries

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached DNS entries

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveOptions.html b/interfaces/_helia_ipns.index.ResolveOptions.html index cd95feefd..205ad14b7 100644 --- a/interfaces/_helia_ipns.index.ResolveOptions.html +++ b/interfaces/_helia_ipns.index.ResolveOptions.html @@ -1,11 +1,11 @@ -ResolveOptions | Helia

                                                                                                                                                                                                                                                          Interface ResolveOptions

                                                                                                                                                                                                                                                          interface ResolveOptions {
                                                                                                                                                                                                                                                              nocache?: boolean;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          nocache? +ResolveOptions | Helia

                                                                                                                                                                                                                                                          Interface ResolveOptions

                                                                                                                                                                                                                                                          interface ResolveOptions {
                                                                                                                                                                                                                                                              nocache?: boolean;
                                                                                                                                                                                                                                                              offline?: boolean;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached IPNS Record entries

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveResult.html b/interfaces/_helia_ipns.index.ResolveResult.html index 8aa1d4cf7..a8af63de6 100644 --- a/interfaces/_helia_ipns.index.ResolveResult.html +++ b/interfaces/_helia_ipns.index.ResolveResult.html @@ -1,7 +1,7 @@ -ResolveResult | Helia

                                                                                                                                                                                                                                                          Interface ResolveResult

                                                                                                                                                                                                                                                          interface ResolveResult {
                                                                                                                                                                                                                                                              cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid +ResolveResult | Helia

                                                                                                                                                                                                                                                          Interface ResolveResult

                                                                                                                                                                                                                                                          interface ResolveResult {
                                                                                                                                                                                                                                                              cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy (view full)

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                                                          The CID that was resolved

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          ""
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.GetOptions.html b/interfaces/_helia_ipns.routing.GetOptions.html index 7b5e6b94c..c083a547e 100644 --- a/interfaces/_helia_ipns.routing.GetOptions.html +++ b/interfaces/_helia_ipns.routing.GetOptions.html @@ -1,7 +1,7 @@ -GetOptions | Helia
                                                                                                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                              validate?: boolean;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? +GetOptions | Helia
                                                                                                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                              validate?: boolean;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            • (evt): void
                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                              • evt: any

                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          validate?: boolean

                                                                                                                                                                                                                                                          Pass false to not perform validation actions

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.IPNSRouting.html b/interfaces/_helia_ipns.routing.IPNSRouting.html index caca43183..292d13f3b 100644 --- a/interfaces/_helia_ipns.routing.IPNSRouting.html +++ b/interfaces/_helia_ipns.routing.IPNSRouting.html @@ -1,3 +1,3 @@ -IPNSRouting | Helia
                                                                                                                                                                                                                                                          interface IPNSRouting {
                                                                                                                                                                                                                                                              get(routingKey, options?): Promise<Uint8Array>;
                                                                                                                                                                                                                                                              put(routingKey, marshaledRecord, options?): Promise<void>;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          get +IPNSRouting | Helia
                                                                                                                                                                                                                                                          interface IPNSRouting {
                                                                                                                                                                                                                                                              get(routingKey, options?): Promise<Uint8Array>;
                                                                                                                                                                                                                                                              put(routingKey, marshaledRecord, options?): Promise<void>;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.PutOptions.html b/interfaces/_helia_ipns.routing.PutOptions.html index 241ad21bf..15d1f1a5e 100644 --- a/interfaces/_helia_ipns.routing.PutOptions.html +++ b/interfaces/_helia_ipns.routing.PutOptions.html @@ -1,3 +1,3 @@ -PutOptions | Helia
                                                                                                                                                                                                                                                          interface PutOptions {
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? +PutOptions | Helia
                                                                                                                                                                                                                                                          interface PutOptions {
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            • (evt): void
                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                              • evt: any

                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.AddOptions.html b/interfaces/_helia_json.AddOptions.html index d4c1ef0f1..2d753fde8 100644 --- a/interfaces/_helia_json.AddOptions.html +++ b/interfaces/_helia_json.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | Helia

                                                                                                                                                                                                                                                          Interface AddOptions

                                                                                                                                                                                                                                                          interface AddOptions {
                                                                                                                                                                                                                                                              hasher: MultihashHasher<number>;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          hasher +AddOptions | Helia

                                                                                                                                                                                                                                                          Interface AddOptions

                                                                                                                                                                                                                                                          interface AddOptions {
                                                                                                                                                                                                                                                              hasher: MultihashHasher<number>;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          hasher: MultihashHasher<number>
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          hasher: MultihashHasher<number>
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.GetOptions.html b/interfaces/_helia_json.GetOptions.html index 2eac639bb..019df5eac 100644 --- a/interfaces/_helia_json.GetOptions.html +++ b/interfaces/_helia_json.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | Helia

                                                                                                                                                                                                                                                          Interface GetOptions

                                                                                                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codec +GetOptions | Helia

                                                                                                                                                                                                                                                          Interface GetOptions

                                                                                                                                                                                                                                                          interface GetOptions {
                                                                                                                                                                                                                                                              codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                              onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          signal?: AbortSignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.JSON.html b/interfaces/_helia_json.JSON.html index 769779945..9d9c5bbfd 100644 --- a/interfaces/_helia_json.JSON.html +++ b/interfaces/_helia_json.JSON.html @@ -1,13 +1,13 @@ JSON | Helia

                                                                                                                                                                                                                                                          Interface JSON

                                                                                                                                                                                                                                                          The JSON interface provides a simple and intuitive way to add/get objects with your Helia node and is a great place to start learning about IPFS.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          interface JSON {
                                                                                                                                                                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          add +
                                                                                                                                                                                                                                                          interface JSON {
                                                                                                                                                                                                                                                              add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                              get<T>(cid, options?): Promise<T>;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          • Add an object to your Helia node and get a CID that refers to the block the object has been stored as.

                                                                                                                                                                                                                                                            Parameters

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

                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                            import { json } from '@helia/json'

                                                                                                                                                                                                                                                            const j = json(helia)
                                                                                                                                                                                                                                                            const cid = await str.add({ hello: 'world' })

                                                                                                                                                                                                                                                            console.info(cid)
                                                                                                                                                                                                                                                            // CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                          • Get an object from your Helia node, either previously added to it or to another node on the network.

                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            Returns Promise<T>

                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                            import { json } from '@helia/json'
                                                                                                                                                                                                                                                            import { CID } from 'multiformats/cid'

                                                                                                                                                                                                                                                            const j = json(helia)
                                                                                                                                                                                                                                                            const cid = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
                                                                                                                                                                                                                                                            const obj = await j.get(cid)

                                                                                                                                                                                                                                                            console.info(obj)
                                                                                                                                                                                                                                                            // { hello: 'world' }
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.JSONComponents.html b/interfaces/_helia_json.JSONComponents.html index a4fb69f0c..bfca267b8 100644 --- a/interfaces/_helia_json.JSONComponents.html +++ b/interfaces/_helia_json.JSONComponents.html @@ -1,2 +1,2 @@ -JSONComponents | Helia

                                                                                                                                                                                                                                                          Interface JSONComponents

                                                                                                                                                                                                                                                          interface JSONComponents {
                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                          \ No newline at end of file +JSONComponents | Helia

                                                                                                                                                                                                                                                                          Interface JSONComponents

                                                                                                                                                                                                                                                                          interface JSONComponents {
                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFS.html b/interfaces/_helia_mfs.MFS.html index 396a2952f..9850ea1c7 100644 --- a/interfaces/_helia_mfs.MFS.html +++ b/interfaces/_helia_mfs.MFS.html @@ -1,6 +1,6 @@ MFS | Helia

                                                                                                                                                                                                                                                                                          Interface MFS

                                                                                                                                                                                                                                                                                          The MFS interface allows working with files and directories in a mutable file system.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          interface MFS {
                                                                                                                                                                                                                                                                                              cat(path, options?): AsyncIterable<Uint8Array>;
                                                                                                                                                                                                                                                                                              chmod(path, mode, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              cp(source, destination, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              ls(path?, options?): AsyncIterable<UnixFSEntry>;
                                                                                                                                                                                                                                                                                              mkdir(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              rm(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              stat(path, options?): Promise<UnixFSStats>;
                                                                                                                                                                                                                                                                                              touch(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              writeByteStream(bytes, path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              writeBytes(bytes, path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                          cat +
                                                                                                                                                                                                                                                                                          interface MFS {
                                                                                                                                                                                                                                                                                              cat(path, options?): AsyncIterable<Uint8Array>;
                                                                                                                                                                                                                                                                                              chmod(path, mode, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              cp(source, destination, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              ls(path?, options?): AsyncIterable<UnixFSEntry>;
                                                                                                                                                                                                                                                                                              mkdir(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              rm(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              stat(path, options?): Promise<UnixFSStats>;
                                                                                                                                                                                                                                                                                              touch(path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              writeByteStream(bytes, path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                              writeBytes(bytes, path, options?): Promise<void>;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                          cat chmod cp ls @@ -13,34 +13,34 @@

                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                          • Change the permissions on a file or directory in your MFS

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                            await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
                                                                                                                                                                                                                                                                                            const beforeStats = await fs.stat('/foo.txt')

                                                                                                                                                                                                                                                                                            await fs.chmod('/foo.txt', 0x755)
                                                                                                                                                                                                                                                                                            const afterStats = await fs.stat('/foo.txt')

                                                                                                                                                                                                                                                                                            console.info(beforeStats)
                                                                                                                                                                                                                                                                                            console.info(afterStats)
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Add a file or directory to a target directory in your MFS.

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                            await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
                                                                                                                                                                                                                                                                                            await fs.mkdir('/bar')

                                                                                                                                                                                                                                                                                            await fs.cp('/foo.txt', '/bar')

                                                                                                                                                                                                                                                                                            Copy a file from one place to another in your MFS.

                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                            await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')

                                                                                                                                                                                                                                                                                            await fs.cp('/foo.txt', '/bar.txt')
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Update the mtime of a UnixFS DAG in your MFS.

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                            await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
                                                                                                                                                                                                                                                                                            const beforeStats = await fs.stat('/foo.txt')

                                                                                                                                                                                                                                                                                            await fs.touch('/foo.txt')
                                                                                                                                                                                                                                                                                            const afterStats = await fs.stat(afterCid)

                                                                                                                                                                                                                                                                                            console.info(beforeStats)
                                                                                                                                                                                                                                                                                            console.info(afterStats)
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Add a stream of Uint8Array to your MFS as a file.

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                            import fs from 'node:fs'

                                                                                                                                                                                                                                                                                            const stream = fs.createReadStream('./foo.txt')
                                                                                                                                                                                                                                                                                            await fs.writeByteStream(stream, '/foo.txt')
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFSComponents.html b/interfaces/_helia_mfs.MFSComponents.html index 72f405bd0..8f450b726 100644 --- a/interfaces/_helia_mfs.MFSComponents.html +++ b/interfaces/_helia_mfs.MFSComponents.html @@ -1,3 +1,3 @@ -MFSComponents | Helia

                                                                                                                                                                                                                                                                                          Interface MFSComponents

                                                                                                                                                                                                                                                                                          interface MFSComponents {
                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          blockstore +MFSComponents | Helia

                                                                                                                                                                                                                                                                                          Interface MFSComponents

                                                                                                                                                                                                                                                                                          interface MFSComponents {
                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFSInit.html b/interfaces/_helia_mfs.MFSInit.html index 840ba97fd..f702a576e 100644 --- a/interfaces/_helia_mfs.MFSInit.html +++ b/interfaces/_helia_mfs.MFSInit.html @@ -1,3 +1,3 @@ -MFSInit | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface MFSInit

                                                                                                                                                                                                                                                                                                                                                                  interface MFSInit {
                                                                                                                                                                                                                                                                                                                                                                      key?: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  key? +MFSInit | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface MFSInit

                                                                                                                                                                                                                                                                                                                                                                  interface MFSInit {
                                                                                                                                                                                                                                                                                                                                                                      key?: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  key?: string

                                                                                                                                                                                                                                                                                                                                                                  The key used to store the root CID in the datastore (default: '/local/filesroot')

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_mfs.RmOptions.html b/interfaces/_helia_mfs.RmOptions.html index b6c6c865d..7f94fcf8c 100644 --- a/interfaces/_helia_mfs.RmOptions.html +++ b/interfaces/_helia_mfs.RmOptions.html @@ -1,12 +1,12 @@ RmOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface RmOptions

                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the rm command

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  force: boolean

                                                                                                                                                                                                                                                                                                                                                                  If true, allow attempts to delete files or directories that do not exist (default: false)

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                  diff --git a/interfaces/_helia_strings.AddOptions.html b/interfaces/_helia_strings.AddOptions.html index a7392bd1f..554139bed 100644 --- a/interfaces/_helia_strings.AddOptions.html +++ b/interfaces/_helia_strings.AddOptions.html @@ -1,5 +1,5 @@ -AddOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface AddOptions

                                                                                                                                                                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                                                                                                                                                                      codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                                                                                                                                      hasher: MultihashHasher<number>;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec +AddOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface AddOptions

                                                                                                                                                                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                                                                                                                                                                      codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                                                                                                                                      hasher: MultihashHasher<number>;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                                                                                                                                  hasher: MultihashHasher<number>
                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                                                                                                                                  hasher: MultihashHasher<number>
                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.GetOptions.html b/interfaces/_helia_strings.GetOptions.html index fd0a567b4..bc8f24fa7 100644 --- a/interfaces/_helia_strings.GetOptions.html +++ b/interfaces/_helia_strings.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface GetOptions

                                                                                                                                                                                                                                                                                                                                                                  interface GetOptions {
                                                                                                                                                                                                                                                                                                                                                                      codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec +GetOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface GetOptions

                                                                                                                                                                                                                                                                                                                                                                  interface GetOptions {
                                                                                                                                                                                                                                                                                                                                                                      codec: BlockCodec<any, unknown>;
                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>
                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.Strings.html b/interfaces/_helia_strings.Strings.html index e49c19487..6a88cf93a 100644 --- a/interfaces/_helia_strings.Strings.html +++ b/interfaces/_helia_strings.Strings.html @@ -1,13 +1,13 @@ Strings | Helia

                                                                                                                                                                                                                                                                                                                                                                  The Strings interface provides a simple and intuitive way to add/get strings with your Helia node and is a great place to start learning about IPFS.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  interface Strings {
                                                                                                                                                                                                                                                                                                                                                                      add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                      get(cid, options?): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                  add +
                                                                                                                                                                                                                                                                                                                                                                  interface Strings {
                                                                                                                                                                                                                                                                                                                                                                      add(str, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                      get(cid, options?): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                  • Add a string to your Helia node and get a CID that refers to the block the string has been stored as.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

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

                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                    import { strings } from '@helia/strings'

                                                                                                                                                                                                                                                                                                                                                                    const str = strings(helia)
                                                                                                                                                                                                                                                                                                                                                                    const cid = await str.add('hello world')

                                                                                                                                                                                                                                                                                                                                                                    console.info(cid)
                                                                                                                                                                                                                                                                                                                                                                    // CID(bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e)
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • Get a string from your Helia node, either previously added to it or to another node on the network.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                    import { strings } from '@helia/strings'
                                                                                                                                                                                                                                                                                                                                                                    import { CID } from 'multiformats/cid'

                                                                                                                                                                                                                                                                                                                                                                    const str = strings(helia)
                                                                                                                                                                                                                                                                                                                                                                    const cid = CID.parse('bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e')
                                                                                                                                                                                                                                                                                                                                                                    const string = await str.get(cid)

                                                                                                                                                                                                                                                                                                                                                                    console.info(string)
                                                                                                                                                                                                                                                                                                                                                                    // hello world
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.StringsComponents.html b/interfaces/_helia_strings.StringsComponents.html index e49de5580..066a444db 100644 --- a/interfaces/_helia_strings.StringsComponents.html +++ b/interfaces/_helia_strings.StringsComponents.html @@ -1,2 +1,2 @@ -StringsComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface StringsComponents

                                                                                                                                                                                                                                                                                                                                                                  interface StringsComponents {
                                                                                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +StringsComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                                  Interface StringsComponents

                                                                                                                                                                                                                                                                                                                                                                                  interface StringsComponents {
                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.AddOptions.html b/interfaces/_helia_unixfs.index.AddOptions.html index a72d4e0c8..3850d90df 100644 --- a/interfaces/_helia_unixfs.index.AddOptions.html +++ b/interfaces/_helia_unixfs.index.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | Helia
                                                                                                                                                                                                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      blockWriteConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      bufferImporter?: BufferImporter;
                                                                                                                                                                                                                                                                                                                                                                                                      chunkValidator?: ChunkValidator;
                                                                                                                                                                                                                                                                                                                                                                                                      chunker?: Chunker;
                                                                                                                                                                                                                                                                                                                                                                                                      cidVersion?: Version;
                                                                                                                                                                                                                                                                                                                                                                                                      dagBuilder?: DAGBuilder;
                                                                                                                                                                                                                                                                                                                                                                                                      fileImportConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      layout?: FileLayout;
                                                                                                                                                                                                                                                                                                                                                                                                      leafType?: "file" | "raw";
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      rawLeaves?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      reduceSingleLeafToSelf?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardFanoutBits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                      treeBuilder?: TreeBuilder;
                                                                                                                                                                                                                                                                                                                                                                                                      wrapWithDirectory?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockWriteConcurrency? +AddOptions | Helia
                                                                                                                                                                                                                                                                                                                                                                                                  interface AddOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      blockWriteConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      bufferImporter?: BufferImporter;
                                                                                                                                                                                                                                                                                                                                                                                                      chunkValidator?: ChunkValidator;
                                                                                                                                                                                                                                                                                                                                                                                                      chunker?: Chunker;
                                                                                                                                                                                                                                                                                                                                                                                                      cidVersion?: Version;
                                                                                                                                                                                                                                                                                                                                                                                                      dagBuilder?: DAGBuilder;
                                                                                                                                                                                                                                                                                                                                                                                                      fileImportConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      layout?: FileLayout;
                                                                                                                                                                                                                                                                                                                                                                                                      leafType?: "file" | "raw";
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      rawLeaves?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      reduceSingleLeafToSelf?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardFanoutBits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                      treeBuilder?: TreeBuilder;
                                                                                                                                                                                                                                                                                                                                                                                                      wrapWithDirectory?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockWriteConcurrency? bufferImporter? chunkValidator? chunker? diff --git a/interfaces/_helia_unixfs.index.CatOptions.html b/interfaces/_helia_unixfs.index.CatOptions.html index 80a5c8242..bbc70226c 100644 --- a/interfaces/_helia_unixfs.index.CatOptions.html +++ b/interfaces/_helia_unixfs.index.CatOptions.html @@ -1,13 +1,13 @@ CatOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the cat command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface CatOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      length?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface CatOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      length?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  length?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Stop reading the file after this many bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the file at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow reading files inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the file at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow reading files inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.ChmodOptions.html b/interfaces/_helia_unixfs.index.ChmodOptions.html index c3210e057..ec4dd0992 100644 --- a/interfaces/_helia_unixfs.index.ChmodOptions.html +++ b/interfaces/_helia_unixfs.index.ChmodOptions.html @@ -1,5 +1,5 @@ ChmodOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the chmod command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface ChmodOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      recursive: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface ChmodOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      recursive: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set the mode on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If the target of the operation is a directory and this is true, +

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set the mode on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If the target of the operation is a directory and this is true, apply the new mode to all directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks +

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.CpOptions.html b/interfaces/_helia_unixfs.index.CpOptions.html index 84997ad6b..466b3ee25 100644 --- a/interfaces/_helia_unixfs.index.CpOptions.html +++ b/interfaces/_helia_unixfs.index.CpOptions.html @@ -1,12 +1,12 @@ CpOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the cp command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface CpOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface CpOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, allow overwriting existing directory entries (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks +

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.LsOptions.html b/interfaces/_helia_unixfs.index.LsOptions.html index dbb16b55f..7a1ac5ecc 100644 --- a/interfaces/_helia_unixfs.index.LsOptions.html +++ b/interfaces/_helia_unixfs.index.LsOptions.html @@ -1,14 +1,14 @@ LsOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the ls command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface LsOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      length?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface LsOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      length?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      offset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  length?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Stop reading the directory contents after this many directory entries

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the directory entries at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to list subdirectory contents if the target CID resolves to +

                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the directory entries at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to list subdirectory contents if the target CID resolves to a directory

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.MkdirOptions.html b/interfaces/_helia_unixfs.index.MkdirOptions.html index f9cc3204a..0213c6d44 100644 --- a/interfaces/_helia_unixfs.index.MkdirOptions.html +++ b/interfaces/_helia_unixfs.index.MkdirOptions.html @@ -1,5 +1,5 @@ MkdirOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the mkdir command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface MkdirOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      cidVersion: Version;
                                                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      mode?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface MkdirOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      cidVersion: Version;
                                                                                                                                                                                                                                                                                                                                                                                                      force: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      mode?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersion force mode? mtime? @@ -9,11 +9,11 @@ signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersion: Version

                                                                                                                                                                                                                                                                                                                                                                                                  The CID version to create the new directory with - defaults to the same version as the containing directory

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, allow overwriting existing directory entries (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mode to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mtime to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, allow overwriting existing directory entries (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mode to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mtime to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks +

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.RmOptions.html b/interfaces/_helia_unixfs.index.RmOptions.html index 9daed0ff6..6f4d0faa1 100644 --- a/interfaces/_helia_unixfs.index.RmOptions.html +++ b/interfaces/_helia_unixfs.index.RmOptions.html @@ -1,10 +1,10 @@ RmOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the rm command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks +

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.StatOptions.html b/interfaces/_helia_unixfs.index.StatOptions.html index cf6b4f594..7cd01db24 100644 --- a/interfaces/_helia_unixfs.index.StatOptions.html +++ b/interfaces/_helia_unixfs.index.StatOptions.html @@ -1,9 +1,9 @@ StatOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the stat command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface StatOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface StatOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void
                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow statting paths inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow statting paths inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.TouchOptions.html b/interfaces/_helia_unixfs.index.TouchOptions.html index 05cf9e6be..512bfab2b 100644 --- a/interfaces/_helia_unixfs.index.TouchOptions.html +++ b/interfaces/_helia_unixfs.index.TouchOptions.html @@ -1,5 +1,5 @@ TouchOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the touch command

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface TouchOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      recursive: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface TouchOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      offline?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      recursive: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      shardSplitThresholdBytes: number;
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime to set on the DAG root, defaults to the current time

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are +

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set mtime on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If the DAG is a directory and this is true, update the mtime on all contents

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks +

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set mtime on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

                                                                                                                                                                                                                                                                                                                                                                                                  If the DAG is a directory and this is true, update the mtime on all contents

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

                                                                                                                                                                                                                                                                                                                                                                                                  DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFS.html b/interfaces/_helia_unixfs.index.UnixFS.html index 07f07a33f..b15463e60 100644 --- a/interfaces/_helia_unixfs.index.UnixFS.html +++ b/interfaces/_helia_unixfs.index.UnixFS.html @@ -1,6 +1,6 @@ UnixFS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  The UnixFS interface provides familiar filesystem operations to make working with UnixFS DAGs simple and intuitive.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFS {
                                                                                                                                                                                                                                                                                                                                                                                                      addAll(source, options?): AsyncIterable<ImportResult>;
                                                                                                                                                                                                                                                                                                                                                                                                      addByteStream(bytes, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addBytes(bytes, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addDirectory(dir?, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addFile(file, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      cat(cid, options?): AsyncIterable<Uint8Array>;
                                                                                                                                                                                                                                                                                                                                                                                                      chmod(cid, mode, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      cp(source, target, name, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      ls(cid, options?): AsyncIterable<UnixFSEntry>;
                                                                                                                                                                                                                                                                                                                                                                                                      mkdir(cid, dirname, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      rm(cid, path, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      stat(cid, options?): Promise<UnixFSStats>;
                                                                                                                                                                                                                                                                                                                                                                                                      touch(cid, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFS {
                                                                                                                                                                                                                                                                                                                                                                                                      addAll(source, options?): AsyncIterable<ImportResult>;
                                                                                                                                                                                                                                                                                                                                                                                                      addByteStream(bytes, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addBytes(bytes, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addDirectory(dir?, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      addFile(file, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      cat(cid, options?): AsyncIterable<Uint8Array>;
                                                                                                                                                                                                                                                                                                                                                                                                      chmod(cid, mode, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      cp(source, target, name, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      ls(cid, options?): AsyncIterable<UnixFSEntry>;
                                                                                                                                                                                                                                                                                                                                                                                                      mkdir(cid, dirname, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      rm(cid, path, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                      stat(cid, options?): Promise<UnixFSStats>;
                                                                                                                                                                                                                                                                                                                                                                                                      touch(cid, options?): Promise<CID<unknown, number, number, Version>>;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                  addAll addByteStream addBytes addDirectory @@ -18,40 +18,40 @@ for input/output types.

                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  Returns AsyncIterable<ImportResult>

                                                                                                                                                                                                                                                                                                                                                                                                  Example

                                                                                                                                                                                                                                                                                                                                                                                                  const source = [{
                                                                                                                                                                                                                                                                                                                                                                                                  path: './foo.txt',
                                                                                                                                                                                                                                                                                                                                                                                                  content: Uint8Array.from([0, 1, 2, 3])
                                                                                                                                                                                                                                                                                                                                                                                                  }, {
                                                                                                                                                                                                                                                                                                                                                                                                  path: './bar.txt',
                                                                                                                                                                                                                                                                                                                                                                                                  content: Uint8Array.from([4, 5, 6, 7])
                                                                                                                                                                                                                                                                                                                                                                                                  }]

                                                                                                                                                                                                                                                                                                                                                                                                  for await (const entry of fs.import(source)) {
                                                                                                                                                                                                                                                                                                                                                                                                  console.info(entry)
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  • Change the permissions on a file or directory in a DAG

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

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

                                                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                                                    const beforeCid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3]))
                                                                                                                                                                                                                                                                                                                                                                                                    const beforeStats = await fs.stat(beforeCid)

                                                                                                                                                                                                                                                                                                                                                                                                    const afterCid = await fs.chmod(cid, 0x755)
                                                                                                                                                                                                                                                                                                                                                                                                    const afterStats = await fs.stat(afterCid)

                                                                                                                                                                                                                                                                                                                                                                                                    console.info(beforeCid, beforeStats)
                                                                                                                                                                                                                                                                                                                                                                                                    console.info(afterCid, afterStats)
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                  • Add a file or directory to a target directory.

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

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

                                                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                                                    const fileCid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3]))
                                                                                                                                                                                                                                                                                                                                                                                                    const directoryCid = await fs.addDirectory()

                                                                                                                                                                                                                                                                                                                                                                                                    const updatedCid = await fs.cp(fileCid, directoryCid, 'foo.txt')

                                                                                                                                                                                                                                                                                                                                                                                                    console.info(updatedCid)
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                  • Remove a file or directory from an existing directory.

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

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

                                                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                                                    const directoryCid = await fs.addDirectory()
                                                                                                                                                                                                                                                                                                                                                                                                    const updatedCid = await fs.mkdir(directoryCid, 'new-dir')

                                                                                                                                                                                                                                                                                                                                                                                                    const finalCid = await fs.rm(updatedCid, 'new-dir')

                                                                                                                                                                                                                                                                                                                                                                                                    console.info(finalCid)
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                  • Update the mtime of a UnixFS DAG

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

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

                                                                                                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                                                                                                    const beforeCid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3]))
                                                                                                                                                                                                                                                                                                                                                                                                    const beforeStats = await fs.stat(beforeCid)

                                                                                                                                                                                                                                                                                                                                                                                                    const afterCid = await fs.touch(beforeCid)
                                                                                                                                                                                                                                                                                                                                                                                                    const afterStats = await fs.stat(afterCid)

                                                                                                                                                                                                                                                                                                                                                                                                    console.info(beforeCid, beforeStats)
                                                                                                                                                                                                                                                                                                                                                                                                    console.info(afterCid, afterStats)
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFSComponents.html b/interfaces/_helia_unixfs.index.UnixFSComponents.html index 9f2500566..8852d5e3b 100644 --- a/interfaces/_helia_unixfs.index.UnixFSComponents.html +++ b/interfaces/_helia_unixfs.index.UnixFSComponents.html @@ -1,2 +1,2 @@ -UnixFSComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnixFSComponents

                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFSComponents {
                                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Pick<Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>, "put" | "get" | "has">;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Pick<Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>, "put" | "get" | "has">
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +UnixFSComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnixFSComponents

                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFSComponents {
                                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Pick<Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>, "put" | "get" | "has">;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Pick<Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>, "put" | "get" | "has">
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFSStats.html b/interfaces/_helia_unixfs.index.UnixFSStats.html index 8eddc0f83..b26b82032 100644 --- a/interfaces/_helia_unixfs.index.UnixFSStats.html +++ b/interfaces/_helia_unixfs.index.UnixFSStats.html @@ -1,5 +1,5 @@ UnixFSStats | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Statistics relating to a UnixFS DAG

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFSStats {
                                                                                                                                                                                                                                                                                                                                                                                                      blocks: number;
                                                                                                                                                                                                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                                                                                                                                                                      dagSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      fileSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      localDagSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      localFileSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      mode?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      type: "file" | "raw" | "directory";
                                                                                                                                                                                                                                                                                                                                                                                                      unixfs?: UnixFS;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  interface UnixFSStats {
                                                                                                                                                                                                                                                                                                                                                                                                      blocks: number;
                                                                                                                                                                                                                                                                                                                                                                                                      cid: CID<unknown, number, number, Version>;
                                                                                                                                                                                                                                                                                                                                                                                                      dagSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      fileSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      localDagSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      localFileSize: bigint;
                                                                                                                                                                                                                                                                                                                                                                                                      mode?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      mtime?: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                      type: "file" | "raw" | "directory";
                                                                                                                                                                                                                                                                                                                                                                                                      unixfs?: UnixFS;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blocks cid dagSize fileSize @@ -11,14 +11,14 @@ unixfs?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blocks: number

                                                                                                                                                                                                                                                                                                                                                                                                  How many blocks make up the DAG - nb. this will only be accurate if all blocks are present in the local blockstore

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory CID

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  dagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the DAG that holds the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  fileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the DAG that holds the file is in the local blockstore

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the file is in the local block store

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mode

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mtime

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  type: "file" | "raw" | "directory"

                                                                                                                                                                                                                                                                                                                                                                                                  The type of file

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  unixfs?: UnixFS

                                                                                                                                                                                                                                                                                                                                                                                                  UnixFS metadata about this file or directory. Will not be present +

                                                                                                                                                                                                                                                                                                                                                                                                  cid: CID<unknown, number, number, Version>

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory CID

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  dagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the DAG that holds the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  fileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the DAG that holds the file is in the local blockstore

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the file is in the local block store

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mode

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mtime

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  type: "file" | "raw" | "directory"

                                                                                                                                                                                                                                                                                                                                                                                                  The type of file

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  unixfs?: UnixFS

                                                                                                                                                                                                                                                                                                                                                                                                  UnixFS metadata about this file or directory. Will not be present if the node is a raw type.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_utils.AbstractCreateSessionOptions.html b/interfaces/_helia_utils.AbstractCreateSessionOptions.html index 5d394db32..1c39f6a80 100644 --- a/interfaces/_helia_utils.AbstractCreateSessionOptions.html +++ b/interfaces/_helia_utils.AbstractCreateSessionOptions.html @@ -1,4 +1,4 @@ -AbstractCreateSessionOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface AbstractCreateSessionOptions

                                                                                                                                                                                                                                                                                                                                                                                                  interface AbstractCreateSessionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      maxProviders?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      minProviders?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  maxProviders? +AbstractCreateSessionOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface AbstractCreateSessionOptions

                                                                                                                                                                                                                                                                                                                                                                                                  interface AbstractCreateSessionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      maxProviders?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      minProviders?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                      onProgress?: ((evt) => void);
                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  maxProviders? minProviders? name onProgress? @@ -12,4 +12,4 @@ discovered, up to maxProviders providers will continue to be added.

                                                                                                                                                                                                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                   
                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_utils.HeliaInit.html b/interfaces/_helia_utils.HeliaInit.html index eafa3c882..638bad696 100644 --- a/interfaces/_helia_utils.HeliaInit.html +++ b/interfaces/_helia_utils.HeliaInit.html @@ -1,5 +1,5 @@ HeliaInit | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface HeliaInit

                                                                                                                                                                                                                                                                                                                                                                                                  Options used to create a Helia node.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  interface HeliaInit {
                                                                                                                                                                                                                                                                                                                                                                                                      blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                      components?: Record<string, any>;
                                                                                                                                                                                                                                                                                                                                                                                                      dagWalkers?: DAGWalker[];
                                                                                                                                                                                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                      dns?: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                      hashers?: MultihashHasher<number>[];
                                                                                                                                                                                                                                                                                                                                                                                                      holdGcLock?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                      logger?: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                      metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                      providerLookupConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                      routers?: Partial<Routing>[];
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  • HeliaInit

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    interface HeliaInit {
                                                                                                                                                                                                                                                                                                                                                                                                        blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                                                                                                                                                                                                                                                        blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                        components?: Record<string, any>;
                                                                                                                                                                                                                                                                                                                                                                                                        dagWalkers?: DAGWalker[];
                                                                                                                                                                                                                                                                                                                                                                                                        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                        dns?: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                        hashers?: MultihashHasher<number>[];
                                                                                                                                                                                                                                                                                                                                                                                                        holdGcLock?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                        logger?: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                        providerLookupConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                        routers?: Partial<Routing>[];
                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                    • HeliaInit

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[]

                                                                                                                                                                                                                                                                                                                                                                                                      A list of strategies used to fetch blocks when they are not present in the local blockstore

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                      The blockstore is where blocks are stored

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      components?: Record<string, any>

                                                                                                                                                                                                                                                                                                                                                                                                                      Components used by subclasses

                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      dagWalkers?: DAGWalker[]

                                                                                                                                                                                                                                                                                                                                                                                                                      In order to pin CIDs that correspond to a DAG, it's necessary to know +

                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                      The blockstore is where blocks are stored

                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                      components?: Record<string, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Components used by subclasses

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      dagWalkers?: DAGWalker[]

                                                                                                                                                                                                                                                                                                                                                                                                                                      In order to pin CIDs that correspond to a DAG, it's necessary to know how to traverse that DAG. DAGWalkers take a block and yield any CIDs encoded within that block.

                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                                      The datastore is where data is stored

                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                          dns?: DNS

                                                                                                                                                                                                                                                                                                                                                                                                                                                          An optional DNS implementation used to perform queries for DNS records.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          hashers?: MultihashHasher<number>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                          By default sha256, sha512 and identity hashes are supported for +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                                                          The datastore is where data is stored

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dns?: DNS

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional DNS implementation used to perform queries for DNS records.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hashers?: MultihashHasher<number>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              By default sha256, sha512 and identity hashes are supported for bitswap operations. To bitswap blocks with CIDs using other hashes pass appropriate MultihashHashers here.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              holdGcLock?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Garbage collection requires preventing blockstore writes during searches +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              holdGcLock?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Garbage collection requires preventing blockstore writes during searches for unpinned blocks as DAGs are typically pinned after they've been imported - without locking this could lead to the deletion of blocks while they are being added to the blockstore.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -33,11 +33,11 @@ lock so use this option to control which process that is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional logging component to pass to libp2p. If not specified the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional logging component to pass to libp2p. If not specified the default implementation from libp2p will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A metrics object that can be used to collected arbitrary stats about node +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A metrics object that can be used to collected arbitrary stats about node usage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              providerLookupConcurrency?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              During provider lookups, peers can be returned from routing implementations +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              providerLookupConcurrency?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              During provider lookups, peers can be returned from routing implementations with no multiaddrs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This can happen when they've been retrieved from network peers that only store multiaddrs for a limited amount of time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -47,6 +47,6 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This config value controls the concurrency of that queue.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Routers perform operations such as looking up content providers, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Routers perform operations such as looking up content providers, information about network peers or getting/putting records.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.DAGWalker.html b/interfaces/helia.DAGWalker.html index bc9cc5110..aea6d01f1 100644 --- a/interfaces/helia.DAGWalker.html +++ b/interfaces/helia.DAGWalker.html @@ -1,4 +1,4 @@ DAGWalker | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface DAGWalker

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DAGWalkers take a block and yield CIDs encoded in that block

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DAGWalker {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  codec: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  walk(block): Generator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DAGWalker {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  codec: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  walk(block): Generator<CID<unknown, number, number, Version>, void, undefined>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.DefaultLibp2pServices.html b/interfaces/helia.DefaultLibp2pServices.html index 5d63001b4..6009e5f6a 100644 --- a/interfaces/helia.DefaultLibp2pServices.html +++ b/interfaces/helia.DefaultLibp2pServices.html @@ -1,4 +1,4 @@ -DefaultLibp2pServices | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface DefaultLibp2pServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DefaultLibp2pServices {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoNAT: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dcutr: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delegatedRouting: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dht: KadDHT;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identify: Identify;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keychain: Keychain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ping: PingService;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  relay: CircuitRelayService;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  upnp: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DefaultLibp2pServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT +DefaultLibp2pServices | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface DefaultLibp2pServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DefaultLibp2pServices {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoNAT: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dcutr: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delegatedRouting: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dht: KadDHT;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identify: Identify;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keychain: Keychain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ping: PingService;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  relay: CircuitRelayService;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  upnp: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DefaultLibp2pServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht: KadDHT
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify: Identify
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain: Keychain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht: KadDHT
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify: Identify
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain: Keychain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.HeliaInit.html b/interfaces/helia.HeliaInit.html index 54cbcaea3..463384791 100644 --- a/interfaces/helia.HeliaInit.html +++ b/interfaces/helia.HeliaInit.html @@ -1,5 +1,5 @@ HeliaInit | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface HeliaInit<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Options used to create a Helia node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HeliaInit<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  components?: Record<string, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dagWalkers?: DAGWalker[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dns?: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hashers?: MultihashHasher<number>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  holdGcLock?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keychain?: KeychainInit;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  libp2p?: T | Omit<Libp2pOptions, "start">;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger?: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerLookupConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  routers?: Partial<Routing>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HeliaInit<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockBrokers: ((components) => BlockBroker<ProgressEvent<any, any>, ProgressEvent<any, any>>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  components?: Record<string, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dagWalkers?: DAGWalker[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dns?: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hashers?: MultihashHasher<number>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  holdGcLock?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keychain?: KeychainInit;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  libp2p?: T | Omit<Libp2pOptions, "start">;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger?: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerLookupConcurrency?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  routers?: Partial<Routing>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain?: KeychainInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              By default Helia stores the node's PeerId in an encrypted form in a libp2p keystore. These options control how that keystore is configured.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p?: T | Omit<Libp2pOptions, "start">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A libp2p node is required to perform network operations. Either a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p?: T | Omit<Libp2pOptions, "start">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A libp2p node is required to perform network operations. Either a preconfigured node or options to configure a node can be passed here.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If node options are passed, they will be merged with the default @@ -46,7 +46,7 @@ keys will replace those from the default config.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The libp2p start option is not supported, instead please pass start in the root of the HeliaInit object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional logging component to pass to libp2p. If not specified the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An optional logging component to pass to libp2p. If not specified the default implementation from libp2p will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A metrics object that can be used to collected arbitrary stats about node usage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -63,4 +63,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Routers perform operations such as looking up content providers, information about network peers or getting/putting records.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Pass false to not start the Helia node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.HeliaLibp2p.html b/interfaces/helia.HeliaLibp2p.html index 08223ddfb..d62d00f5c 100644 --- a/interfaces/helia.HeliaLibp2p.html +++ b/interfaces/helia.HeliaLibp2p.html @@ -1,5 +1,5 @@ HeliaLibp2p | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface HeliaLibp2p<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The API presented by a Helia node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HeliaLibp2p<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blocks;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dagWalkers: Record<number, DAGWalker>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dns: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  libp2p: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pins: Pins;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  routing: Routing;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  gc(options?): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stop(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HeliaLibp2p<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockstore: Blocks;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dagWalkers: Record<number, DAGWalker>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dns: DNS;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  libp2p: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger: ComponentLogger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  metrics?: Metrics;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pins: Pins;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  routing: Routing;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  gc(options?): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stop(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockstore dagWalkers datastore dns @@ -20,7 +20,7 @@ will use a resolver appropriate to the current platform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hashers: Record<number, MultihashHasher<number>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hashers can be used to hash a piece of data with the specified hashing algorithm.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A logging component that can be reused by consumers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A logging component that can be reused by consumers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A metrics object that can be used to collected arbitrary stats about node usage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pins: Pins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/modules/_helia_interface.blocks.html b/modules/_helia_interface.blocks.html index 635c70d7a..63e0ee270 100644 --- a/modules/_helia_interface.blocks.html +++ b/modules/_helia_interface.blocks.html @@ -1,4 +1,4 @@ -blocks | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BlockAnnounceOptions +blocks | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BlockAnnounceOptions BlockBroker BlockRetrievalOptions Blocks diff --git a/modules/_helia_interface.index.html b/modules/_helia_interface.index.html index 9d6cd12c9..66b4411eb 100644 --- a/modules/_helia_interface.index.html +++ b/modules/_helia_interface.index.html @@ -1,7 +1,7 @@ index | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The API defined by a Helia node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              import type { Helia } from '@helia/interface'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              export function doSomething(helia: Helia) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // use helia node functions here
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions AddPinEvents BlockAnnounceOptions BlockBroker diff --git a/modules/_helia_interface.pins.html b/modules/_helia_interface.pins.html index 225f99c73..fcf51b610 100644 --- a/modules/_helia_interface.pins.html +++ b/modules/_helia_interface.pins.html @@ -1,4 +1,4 @@ -pins | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions +pins | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions IsPinnedOptions LsOptions Pin diff --git a/modules/_helia_ipns.index.html b/modules/_helia_ipns.index.html index 3b4472a79..9c47ad78b 100644 --- a/modules/_helia_ipns.index.html +++ b/modules/_helia_ipns.index.html @@ -37,7 +37,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example: Using DNS-JSON-Over-HTTPS

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DNS-JSON-Over-HTTPS resolvers use result in a smaller browser bundle due to the response being plain JSON.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // use DNS-JSON-Over-HTTPS
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              import { dnsJsonOverHttps } from '@helia/ipns/dns-resolvers'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const { cid, path } = name.resolveDns('ipfs.io', {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resolvers: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              })
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DNSLinkResolveResult IPNS diff --git a/modules/_helia_ipns.routing.html b/modules/_helia_ipns.routing.html index 715d829a4..c7412bd69 100644 --- a/modules/_helia_ipns.routing.html +++ b/modules/_helia_ipns.routing.html @@ -1,4 +1,4 @@ -routing | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetOptions +routing | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRoutingEvents diff --git a/modules/_helia_unixfs.errors.html b/modules/_helia_unixfs.errors.html index 27b3346c3..8e932bdce 100644 --- a/modules/_helia_unixfs.errors.html +++ b/modules/_helia_unixfs.errors.html @@ -1,4 +1,4 @@ -errors | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AlreadyExistsError +errors | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AlreadyExistsError DoesNotExistError InvalidPBNodeError InvalidParametersError diff --git a/modules/_helia_unixfs.index.html b/modules/_helia_unixfs.index.html index 86d3e98ac..d2ea67ee9 100644 --- a/modules/_helia_unixfs.index.html +++ b/modules/_helia_unixfs.index.html @@ -5,7 +5,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example: Recursively adding a directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Node.js-compatibly environments only:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              import { globSource } from '@helia/unixfs'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              for await (const entry of fs.addAll(globSource('path/to/containing/dir', 'glob-pattern'))) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.info(entry)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions CatOptions ChmodOptions CpOptions diff --git a/types/_helia_bitswap.BitswapNotifyProgressEvents.html b/types/_helia_bitswap.BitswapNotifyProgressEvents.html index d06a2e2b8..76aa0c669 100644 --- a/types/_helia_bitswap.BitswapNotifyProgressEvents.html +++ b/types/_helia_bitswap.BitswapNotifyProgressEvents.html @@ -1 +1 @@ -BitswapNotifyProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapNotifyProgressEvents: BitswapNetworkNotifyProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +BitswapNotifyProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapNotifyProgressEvents: BitswapNetworkNotifyProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_bitswap.BitswapWantBlockProgressEvents.html b/types/_helia_bitswap.BitswapWantBlockProgressEvents.html index f89d7ba26..f3472dfdf 100644 --- a/types/_helia_bitswap.BitswapWantBlockProgressEvents.html +++ b/types/_helia_bitswap.BitswapWantBlockProgressEvents.html @@ -1 +1 @@ -BitswapWantBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantBlockProgressEvents: ProgressEvent<"bitswap:want-block:unwant", CID> | ProgressEvent<"bitswap:want-block:block", CID> | BitswapNetworkWantProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +BitswapWantBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantBlockProgressEvents: ProgressEvent<"bitswap:want-block:unwant", CID> | ProgressEvent<"bitswap:want-block:block", CID> | BitswapNetworkWantProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_bitswap.BitswapWantProgressEvents.html b/types/_helia_bitswap.BitswapWantProgressEvents.html index efea30f76..259f5dcdf 100644 --- a/types/_helia_bitswap.BitswapWantProgressEvents.html +++ b/types/_helia_bitswap.BitswapWantProgressEvents.html @@ -1 +1 @@ -BitswapWantProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantProgressEvents: BitswapWantBlockProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +BitswapWantProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantProgressEvents: BitswapWantBlockProgressEvents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.DeleteBlockProgressEvents.html b/types/_helia_interface.blocks.DeleteBlockProgressEvents.html index 4c2356758..2ab832b74 100644 --- a/types/_helia_interface.blocks.DeleteBlockProgressEvents.html +++ b/types/_helia_interface.blocks.DeleteBlockProgressEvents.html @@ -1 +1 @@ -DeleteBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteBlockProgressEvents: ProgressEvent<"blocks:delete:blockstore:delete", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DeleteBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteBlockProgressEvents: ProgressEvent<"blocks:delete:blockstore:delete", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html b/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html index 58fb7d4bc..10069a829 100644 --- a/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html +++ b/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html @@ -1 +1 @@ -DeleteManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteManyBlocksProgressEvents: ProgressEvent<"blocks:delete-many:blockstore:delete-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DeleteManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteManyBlocksProgressEvents: ProgressEvent<"blocks:delete-many:blockstore:delete-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html b/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html index 65a7348d9..bfe92cd13 100644 --- a/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html +++ b/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html @@ -1 +1 @@ -GetAllBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetAllBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetAllBlocksProgressEvents: ProgressEvent<"blocks:get-all:blockstore:get-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetAllBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetAllBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetAllBlocksProgressEvents: ProgressEvent<"blocks:get-all:blockstore:get-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetBlockProgressEvents.html b/types/_helia_interface.blocks.GetBlockProgressEvents.html index 952a3de97..fa44bb8c1 100644 --- a/types/_helia_interface.blocks.GetBlockProgressEvents.html +++ b/types/_helia_interface.blocks.GetBlockProgressEvents.html @@ -1 +1 @@ -GetBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetBlockProgressEvents: ProgressEvent<"blocks:get:providers:want", CID> | ProgressEvent<"blocks:get:blockstore:get", CID> | ProgressEvent<"blocks:get:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetBlockProgressEvents: ProgressEvent<"blocks:get:providers:want", CID> | ProgressEvent<"blocks:get:blockstore:get", CID> | ProgressEvent<"blocks:get:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html b/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html index df8caf37e..232a65d50 100644 --- a/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html +++ b/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html @@ -1 +1 @@ -GetManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetManyBlocksProgressEvents: ProgressEvent<"blocks:get-many:blockstore:get-many"> | ProgressEvent<"blocks:get-many:providers:want", CID> | ProgressEvent<"blocks:get-many:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetManyBlocksProgressEvents: ProgressEvent<"blocks:get-many:blockstore:get-many"> | ProgressEvent<"blocks:get-many:providers:want", CID> | ProgressEvent<"blocks:get-many:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.HasBlockProgressEvents.html b/types/_helia_interface.blocks.HasBlockProgressEvents.html index ecab5f670..f2f8b54d3 100644 --- a/types/_helia_interface.blocks.HasBlockProgressEvents.html +++ b/types/_helia_interface.blocks.HasBlockProgressEvents.html @@ -1 +1 @@ -HasBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias HasBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              HasBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:providers:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +HasBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias HasBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              HasBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:providers:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.PutBlockProgressEvents.html b/types/_helia_interface.blocks.PutBlockProgressEvents.html index 051c7c525..a4d964610 100644 --- a/types/_helia_interface.blocks.PutBlockProgressEvents.html +++ b/types/_helia_interface.blocks.PutBlockProgressEvents.html @@ -1 +1 @@ -PutBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PutBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PutBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:providers:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +PutBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PutBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PutBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:providers:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html b/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html index 894a9daf1..24ff45307 100644 --- a/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html +++ b/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html @@ -1 +1 @@ -PutManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PutManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PutManyBlocksProgressEvents: ProgressEvent<"blocks:put-many:duplicate", CID> | ProgressEvent<"blocks:put-many:providers:notify", CID> | ProgressEvent<"blocks:put-many:blockstore:put-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +PutManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PutManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PutManyBlocksProgressEvents: ProgressEvent<"blocks:put-many:duplicate", CID> | ProgressEvent<"blocks:put-many:providers:notify", CID> | ProgressEvent<"blocks:put-many:blockstore:put-many">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.index.GcEvents.html b/types/_helia_interface.index.GcEvents.html index 048cfda94..28c2310ab 100644 --- a/types/_helia_interface.index.GcEvents.html +++ b/types/_helia_interface.index.GcEvents.html @@ -1 +1 @@ -GcEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GcEvents: ProgressEvent<"helia:gc:deleted", CID> | ProgressEvent<"helia:gc:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GcEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GcEvents: ProgressEvent<"helia:gc:deleted", CID> | ProgressEvent<"helia:gc:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.pins.AddPinEvents.html b/types/_helia_interface.pins.AddPinEvents.html index 77e2d3b50..3c672c22c 100644 --- a/types/_helia_interface.pins.AddPinEvents.html +++ b/types/_helia_interface.pins.AddPinEvents.html @@ -1 +1 @@ -AddPinEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddPinEvents: ProgressEvent<"helia:pin:add", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +AddPinEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddPinEvents: ProgressEvent<"helia:pin:add", CID>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.pins.PinType.html b/types/_helia_interface.pins.PinType.html index ccc5f4588..cec0839cf 100644 --- a/types/_helia_interface.pins.PinType.html +++ b/types/_helia_interface.pins.PinType.html @@ -1 +1 @@ -PinType | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PinType: "recursive" | "direct" | "indirect"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +PinType | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PinType: "recursive" | "direct" | "indirect"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.PublishProgressEvents.html b/types/_helia_ipns.index.PublishProgressEvents.html index b9167295c..4b610d55c 100644 --- a/types/_helia_ipns.index.PublishProgressEvents.html +++ b/types/_helia_ipns.index.PublishProgressEvents.html @@ -1 +1 @@ -PublishProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PublishProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSRecord> | ProgressEvent<"ipns:publish:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +PublishProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PublishProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSRecord> | ProgressEvent<"ipns:publish:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.RepublishProgressEvents.html b/types/_helia_ipns.index.RepublishProgressEvents.html index 0fc1f7fa5..282f3c548 100644 --- a/types/_helia_ipns.index.RepublishProgressEvents.html +++ b/types/_helia_ipns.index.RepublishProgressEvents.html @@ -1 +1 @@ -RepublishProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias RepublishProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSRecord> | ProgressEvent<"ipns:republish:error", {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  err: Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  record: IPNSRecord;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +RepublishProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias RepublishProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSRecord> | ProgressEvent<"ipns:republish:error", {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  err: Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  record: IPNSRecord;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html b/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html index dac2a7a08..a4ecf91d9 100644 --- a/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html +++ b/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html @@ -1 +1 @@ -ResolveDNSLinkProgressEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +ResolveDNSLinkProgressEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.ResolveProgressEvents.html b/types/_helia_ipns.index.ResolveProgressEvents.html index 06553a25f..6e382ca1b 100644 --- a/types/_helia_ipns.index.ResolveProgressEvents.html +++ b/types/_helia_ipns.index.ResolveProgressEvents.html @@ -1 +1 @@ -ResolveProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias ResolveProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSRecord> | ProgressEvent<"ipns:resolve:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +ResolveProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias ResolveProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSRecord> | ProgressEvent<"ipns:resolve:error", Error>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.routing.IPNSRoutingEvents.html b/types/_helia_ipns.routing.IPNSRoutingEvents.html index ff66f519d..a48ffb988 100644 --- a/types/_helia_ipns.routing.IPNSRoutingEvents.html +++ b/types/_helia_ipns.routing.IPNSRoutingEvents.html @@ -1 +1 @@ -IPNSRoutingEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +IPNSRoutingEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_mfs.MkdirOptions.html b/types/_helia_mfs.MkdirOptions.html index 09261a2aa..85c501ce4 100644 --- a/types/_helia_mfs.MkdirOptions.html +++ b/types/_helia_mfs.MkdirOptions.html @@ -1 +1 @@ -MkdirOptions | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +MkdirOptions | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_mfs.WriteOptions.html b/types/_helia_mfs.WriteOptions.html index 576768f23..413a26aab 100644 --- a/types/_helia_mfs.WriteOptions.html +++ b/types/_helia_mfs.WriteOptions.html @@ -1,3 +1,3 @@ WriteOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias WriteOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              WriteOptions: AddOptions & CpOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mtime: Mtime;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional mode to set on the new file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mtime: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional mtime to set on the new file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_unixfs.index.AddEvents.html b/types/_helia_unixfs.index.AddEvents.html index 68a78e162..b8a2a2a94 100644 --- a/types/_helia_unixfs.index.AddEvents.html +++ b/types/_helia_unixfs.index.AddEvents.html @@ -1 +1 @@ -AddEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +AddEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_unixfs.index.GetEvents.html b/types/_helia_unixfs.index.GetEvents.html index 34084e30a..29b10a796 100644 --- a/types/_helia_unixfs.index.GetEvents.html +++ b/types/_helia_unixfs.index.GetEvents.html @@ -1 +1 @@ -GetEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetEvents | Helia
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/variables/_helia_interface.blocks.DEFAULT_SESSION_MAX_PROVIDERS.html b/variables/_helia_interface.blocks.DEFAULT_SESSION_MAX_PROVIDERS.html index 679f4fc86..bbaed8b28 100644 --- a/variables/_helia_interface.blocks.DEFAULT_SESSION_MAX_PROVIDERS.html +++ b/variables/_helia_interface.blocks.DEFAULT_SESSION_MAX_PROVIDERS.html @@ -1 +1 @@ -DEFAULT_SESSION_MAX_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MAX_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MAX_PROVIDERS: 5 = 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DEFAULT_SESSION_MAX_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MAX_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MAX_PROVIDERS: 5 = 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/variables/_helia_interface.blocks.DEFAULT_SESSION_MIN_PROVIDERS.html b/variables/_helia_interface.blocks.DEFAULT_SESSION_MIN_PROVIDERS.html index 686adb119..083a4f830 100644 --- a/variables/_helia_interface.blocks.DEFAULT_SESSION_MIN_PROVIDERS.html +++ b/variables/_helia_interface.blocks.DEFAULT_SESSION_MIN_PROVIDERS.html @@ -1 +1 @@ -DEFAULT_SESSION_MIN_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MIN_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MIN_PROVIDERS: 1 = 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DEFAULT_SESSION_MIN_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MIN_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MIN_PROVIDERS: 1 = 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file