From b425a1d2c056d8a348a110929e2fe250822204b1 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Tue, 21 May 2024 09:03:02 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- ...elia_unixfs.errors.AlreadyExistsError.html | 4 +-- ...helia_unixfs.errors.DoesNotExistError.html | 4 +-- ...elia_unixfs.errors.InvalidPBNodeError.html | 4 +-- ..._unixfs.errors.InvalidParametersError.html | 4 +-- .../_helia_unixfs.errors.NoContentError.html | 4 +-- ...elia_unixfs.errors.NotADirectoryError.html | 4 +-- .../_helia_unixfs.errors.NotAFileError.html | 4 +-- .../_helia_unixfs.errors.NotUnixFSError.html | 4 +-- classes/_helia_unixfs.errors.UnixFSError.html | 4 +-- .../_helia_unixfs.errors.UnknownError.html | 4 +-- classes/_helia_utils.AbstractSession.html | 14 +++++----- classes/_helia_utils.BloomFilter.html | 12 ++++---- classes/_helia_utils.Helia.html | 28 +++++++++---------- functions/_helia_bitswap.createBitswap.html | 2 +- functions/_helia_block_brokers.bitswap.html | 2 +- ..._helia_block_brokers.trustlessGateway.html | 2 +- functions/_helia_car.car-1.html | 2 +- functions/_helia_dag_cbor.dagCbor-1.html | 2 +- functions/_helia_dag_json.dagJson-1.html | 2 +- functions/_helia_http.createHeliaHTTP.html | 2 +- functions/_helia_ipns.index.ipns-1.html | 2 +- functions/_helia_ipns.routing.helia.html | 2 +- functions/_helia_ipns.routing.pubsub.html | 2 +- functions/_helia_json.json-1.html | 2 +- functions/_helia_mfs.mfs-1.html | 2 +- .../_helia_routers.delegatedHTTPRouting.html | 2 +- .../_helia_routers.httpGatewayRouting.html | 2 +- functions/_helia_routers.libp2pRouting.html | 2 +- functions/_helia_strings.strings-1.html | 2 +- functions/_helia_unixfs.index.globSource.html | 2 +- functions/_helia_unixfs.index.unixfs-1.html | 2 +- functions/_helia_unixfs.index.urlSource.html | 2 +- functions/helia.createHelia.html | 2 +- functions/helia.libp2pDefaults.html | 2 +- interfaces/_helia_bitswap.Bitswap.html | 12 ++++---- .../_helia_bitswap.BitswapComponents.html | 4 +-- interfaces/_helia_bitswap.BitswapOptions.html | 28 +++++++++---------- .../_helia_bitswap.MultihashHasherLoader.html | 4 +-- interfaces/_helia_bitswap.WantListEntry.html | 4 +-- interfaces/_helia_car.Car.html | 8 +++--- interfaces/_helia_car.CarComponents.html | 4 +-- interfaces/_helia_dag_cbor.AddOptions.html | 4 +-- interfaces/_helia_dag_cbor.DAGCBOR.html | 6 ++-- .../_helia_dag_cbor.DAGCBORComponents.html | 4 +-- interfaces/_helia_dag_cbor.GetOptions.html | 4 +-- interfaces/_helia_dag_json.AddOptions.html | 4 +-- interfaces/_helia_dag_json.DAGJSON.html | 6 ++-- .../_helia_dag_json.DAGJSONComponents.html | 4 +-- interfaces/_helia_dag_json.GetOptions.html | 4 +-- interfaces/_helia_http.HeliaHTTPInit.html | 4 +-- ...interface.blocks.BlockAnnounceOptions.html | 2 +- .../_helia_interface.blocks.BlockBroker.html | 8 +++--- ...nterface.blocks.BlockRetrievalOptions.html | 4 +-- .../_helia_interface.blocks.Blocks.html | 4 +-- ...interface.blocks.CreateSessionOptions.html | 6 ++-- ...ia_interface.blocks.GetOfflineOptions.html | 4 +-- interfaces/_helia_interface.blocks.Pair.html | 4 +-- ...ia_interface.blocks.SessionBlockstore.html | 4 +-- .../_helia_interface.index.DAGWalker.html | 4 +-- .../_helia_interface.index.GCOptions.html | 2 +- interfaces/_helia_interface.index.Helia.html | 26 ++++++++--------- .../_helia_interface.index.Provider.html | 4 +-- .../_helia_interface.index.Routing.html | 14 +++++----- ..._helia_interface.index.RoutingOptions.html | 8 +++--- .../_helia_interface.pins.AddOptions.html | 6 ++-- ..._helia_interface.pins.IsPinnedOptions.html | 2 +- .../_helia_interface.pins.LsOptions.html | 4 +-- interfaces/_helia_interface.pins.Pin.html | 4 +-- interfaces/_helia_interface.pins.Pins.html | 10 +++---- .../_helia_interface.pins.RmOptions.html | 2 +- ...helia_ipns.index.DNSLinkResolveResult.html | 8 +++--- interfaces/_helia_ipns.index.IPNS.html | 10 +++---- .../_helia_ipns.index.IPNSComponents.html | 4 +-- interfaces/_helia_ipns.index.IPNSOptions.html | 4 +-- .../_helia_ipns.index.IPNSResolveResult.html | 8 +++--- .../_helia_ipns.index.PublishOptions.html | 8 +++--- .../_helia_ipns.index.RepublishOptions.html | 4 +-- ...elia_ipns.index.ResolveDNSLinkOptions.html | 8 +++--- .../_helia_ipns.index.ResolveOptions.html | 6 ++-- .../_helia_ipns.index.ResolveResult.html | 6 ++-- .../_helia_ipns.routing.GetOptions.html | 4 +-- .../_helia_ipns.routing.IPNSRouting.html | 4 +-- .../_helia_ipns.routing.PutOptions.html | 2 +- interfaces/_helia_json.AddOptions.html | 4 +-- interfaces/_helia_json.GetOptions.html | 4 +-- interfaces/_helia_json.JSON.html | 6 ++-- interfaces/_helia_json.JSONComponents.html | 4 +-- interfaces/_helia_mfs.MFS.html | 22 +++++++-------- interfaces/_helia_mfs.MFSComponents.html | 4 +-- interfaces/_helia_mfs.MFSInit.html | 4 +-- interfaces/_helia_mfs.RmOptions.html | 4 +-- interfaces/_helia_strings.AddOptions.html | 4 +-- interfaces/_helia_strings.GetOptions.html | 4 +-- interfaces/_helia_strings.Strings.html | 6 ++-- .../_helia_strings.StringsComponents.html | 4 +-- .../_helia_unixfs.index.AddOptions.html | 2 +- .../_helia_unixfs.index.CatOptions.html | 10 +++---- .../_helia_unixfs.index.ChmodOptions.html | 10 +++---- interfaces/_helia_unixfs.index.CpOptions.html | 8 +++--- interfaces/_helia_unixfs.index.LsOptions.html | 10 +++---- .../_helia_unixfs.index.MkdirOptions.html | 14 +++++----- interfaces/_helia_unixfs.index.RmOptions.html | 6 ++-- .../_helia_unixfs.index.StatOptions.html | 6 ++-- .../_helia_unixfs.index.TouchOptions.html | 12 ++++---- interfaces/_helia_unixfs.index.UnixFS.html | 28 +++++++++---------- .../_helia_unixfs.index.UnixFSComponents.html | 4 +-- .../_helia_unixfs.index.UnixFSStats.html | 22 +++++++-------- ...ia_utils.AbstractCreateSessionOptions.html | 4 +-- interfaces/_helia_utils.HeliaInit.html | 26 ++++++++--------- interfaces/helia.DAGWalker.html | 4 +-- interfaces/helia.DefaultLibp2pServices.html | 4 +-- interfaces/helia.HeliaInit.html | 8 +++--- interfaces/helia.HeliaLibp2p.html | 4 +-- modules/_helia_interface.blocks.html | 2 +- modules/_helia_interface.index.html | 2 +- modules/_helia_interface.pins.html | 2 +- modules/_helia_ipns.index.html | 2 +- modules/_helia_ipns.routing.html | 2 +- modules/_helia_unixfs.errors.html | 2 +- modules/_helia_unixfs.index.html | 2 +- ...a_bitswap.BitswapNotifyProgressEvents.html | 2 +- ...itswap.BitswapWantBlockProgressEvents.html | 2 +- ...lia_bitswap.BitswapWantProgressEvents.html | 2 +- ...face.blocks.DeleteBlockProgressEvents.html | 2 +- ...blocks.DeleteManyBlocksProgressEvents.html | 2 +- ...ace.blocks.GetAllBlocksProgressEvents.html | 2 +- ...terface.blocks.GetBlockProgressEvents.html | 2 +- ...ce.blocks.GetManyBlocksProgressEvents.html | 2 +- ...terface.blocks.HasBlockProgressEvents.html | 2 +- ...terface.blocks.PutBlockProgressEvents.html | 2 +- ...ce.blocks.PutManyBlocksProgressEvents.html | 2 +- types/_helia_interface.index.GcEvents.html | 2 +- types/_helia_interface.pins.AddPinEvents.html | 2 +- types/_helia_interface.pins.PinType.html | 2 +- ...elia_ipns.index.PublishProgressEvents.html | 2 +- ...ia_ipns.index.RepublishProgressEvents.html | 2 +- ...ns.index.ResolveDNSLinkProgressEvents.html | 2 +- ...elia_ipns.index.ResolveProgressEvents.html | 2 +- ..._helia_ipns.routing.IPNSRoutingEvents.html | 2 +- types/_helia_mfs.MkdirOptions.html | 2 +- types/_helia_mfs.WriteOptions.html | 2 +- types/_helia_unixfs.index.AddEvents.html | 2 +- types/_helia_unixfs.index.GetEvents.html | 2 +- ....blocks.DEFAULT_SESSION_MAX_PROVIDERS.html | 2 +- ....blocks.DEFAULT_SESSION_MIN_PROVIDERS.html | 2 +- 145 files changed, 377 insertions(+), 377 deletions(-) diff --git a/classes/_helia_unixfs.errors.AlreadyExistsError.html b/classes/_helia_unixfs.errors.AlreadyExistsError.html index b658db31..75a2f259 100644 --- a/classes/_helia_unixfs.errors.AlreadyExistsError.html +++ b/classes/_helia_unixfs.errors.AlreadyExistsError.html @@ -1,4 +1,4 @@ -AlreadyExistsError | Helia

Class AlreadyExistsError

Hierarchy (view full)

Constructors

constructor +AlreadyExistsError | Helia

Class AlreadyExistsError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.DoesNotExistError.html b/classes/_helia_unixfs.errors.DoesNotExistError.html index 97d3c671..7363e9e8 100644 --- a/classes/_helia_unixfs.errors.DoesNotExistError.html +++ b/classes/_helia_unixfs.errors.DoesNotExistError.html @@ -1,4 +1,4 @@ -DoesNotExistError | Helia

Class DoesNotExistError

Hierarchy (view full)

Constructors

constructor +DoesNotExistError | Helia

Class DoesNotExistError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.InvalidPBNodeError.html b/classes/_helia_unixfs.errors.InvalidPBNodeError.html index 1c82d309..a9318a73 100644 --- a/classes/_helia_unixfs.errors.InvalidPBNodeError.html +++ b/classes/_helia_unixfs.errors.InvalidPBNodeError.html @@ -1,4 +1,4 @@ -InvalidPBNodeError | Helia

Class InvalidPBNodeError

Hierarchy (view full)

Constructors

constructor +InvalidPBNodeError | Helia

Class InvalidPBNodeError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.InvalidParametersError.html b/classes/_helia_unixfs.errors.InvalidParametersError.html index 930c0efd..5266a306 100644 --- a/classes/_helia_unixfs.errors.InvalidParametersError.html +++ b/classes/_helia_unixfs.errors.InvalidParametersError.html @@ -1,4 +1,4 @@ -InvalidParametersError | Helia

Class InvalidParametersError

Hierarchy (view full)

Constructors

constructor +InvalidParametersError | Helia

Class InvalidParametersError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.NoContentError.html b/classes/_helia_unixfs.errors.NoContentError.html index 536968f3..8f00d314 100644 --- a/classes/_helia_unixfs.errors.NoContentError.html +++ b/classes/_helia_unixfs.errors.NoContentError.html @@ -1,4 +1,4 @@ -NoContentError | Helia

Class NoContentError

Hierarchy (view full)

Constructors

constructor +NoContentError | Helia

Class NoContentError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.NotADirectoryError.html b/classes/_helia_unixfs.errors.NotADirectoryError.html index 2ea3536e..a2ed3a44 100644 --- a/classes/_helia_unixfs.errors.NotADirectoryError.html +++ b/classes/_helia_unixfs.errors.NotADirectoryError.html @@ -1,4 +1,4 @@ -NotADirectoryError | Helia

Class NotADirectoryError

Hierarchy (view full)

Constructors

constructor +NotADirectoryError | Helia

Class NotADirectoryError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.NotAFileError.html b/classes/_helia_unixfs.errors.NotAFileError.html index b467445b..69639df4 100644 --- a/classes/_helia_unixfs.errors.NotAFileError.html +++ b/classes/_helia_unixfs.errors.NotAFileError.html @@ -1,4 +1,4 @@ -NotAFileError | Helia

Class NotAFileError

Hierarchy (view full)

Constructors

constructor +NotAFileError | Helia

Class NotAFileError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.NotUnixFSError.html b/classes/_helia_unixfs.errors.NotUnixFSError.html index 7c0b191f..98a30231 100644 --- a/classes/_helia_unixfs.errors.NotUnixFSError.html +++ b/classes/_helia_unixfs.errors.NotUnixFSError.html @@ -1,4 +1,4 @@ -NotUnixFSError | Helia

Class NotUnixFSError

Hierarchy (view full)

Constructors

constructor +NotUnixFSError | Helia

Class NotUnixFSError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.UnixFSError.html b/classes/_helia_unixfs.errors.UnixFSError.html index d4359944..1122e363 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

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_unixfs.errors.UnknownError.html b/classes/_helia_unixfs.errors.UnknownError.html index af0000b6..8557c322 100644 --- a/classes/_helia_unixfs.errors.UnknownError.html +++ b/classes/_helia_unixfs.errors.UnknownError.html @@ -1,4 +1,4 @@ -UnknownError | Helia

Class UnknownError

Hierarchy (view full)

Constructors

constructor +UnknownError | Helia

Class UnknownError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_helia_utils.AbstractSession.html b/classes/_helia_utils.AbstractSession.html index 174ecaa0..8c9caf3f 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

constructor

Properties

#private evictionFilter intialPeerSearchComplete? @@ -23,12 +23,12 @@ retrieve safeDispatchEvent toEvictionKey -

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly evictionFilter

evictionFilter: BloomFilter

Private Optional intialPeerSearchComplete

intialPeerSearchComplete?: Promise<void>

Protected log

log: Logger

Protected logger

logger: ComponentLogger

Private Readonly maxProviders

maxProviders: number

Private Readonly minProviders

minProviders: number

Private Readonly name

name: string

Readonly providers

providers: Provider[]

Private Readonly requests

requests: Map<string, Promise<Uint8Array>>

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    Returns boolean

Abstract equals

evict

Abstract findNewProviders

Private findProviders

hasProvider

isEvicted

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

Abstract queryProvider

  • queryProvider(cid, provider, options): Promise<Uint8Array>

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

    +

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly evictionFilter

evictionFilter: BloomFilter

Private Optional intialPeerSearchComplete

intialPeerSearchComplete?: Promise<void>

Protected log

log: Logger

Protected logger

logger: ComponentLogger

Private Readonly maxProviders

maxProviders: number

Private Readonly minProviders

minProviders: number

Private Readonly name

name: string

Readonly providers

providers: Provider[]

Private Readonly requests

requests: Map<string, Promise<Uint8Array>>

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    Returns boolean

Abstract equals

evict

Abstract findNewProviders

Private findProviders

hasProvider

isEvicted

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

Abstract queryProvider

removeEventListener

  • removeEventListener<K>(type, listener?, options?): void

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

retrieve

safeDispatchEvent

  • safeDispatchEvent<Detail>(type, detail?): boolean

  • Type Parameters

    • Detail

    Parameters

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

    Returns boolean

Abstract toEvictionKey

removeEventListener

  • removeEventListener<K>(type, listener?, options?): void

  • Type Parameters

    • K extends "provider"

    Parameters

    Returns void

retrieve

safeDispatchEvent

  • safeDispatchEvent<Detail>(type, detail?): boolean

  • Type Parameters

    • Detail

    Parameters

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

    Returns boolean

Abstract toEvictionKey

Settings

Member Visibility

Theme

On This Page

constructor#privateevictionFilterintialPeerSearchCompletelogloggermaxProvidersminProvidersnameprovidersrequestsaddEventListenerdispatchEventequalsevictfindNewProvidersfindProvidershasProviderisEvictedlistenerCountqueryProviderremoveEventListenerretrievesafeDispatchEventtoEvictionKey
\ No newline at end of file +

Parameters

Returns string | Uint8Array

Settings

Member Visibility

Theme

On This Page

constructor#privateevictionFilterintialPeerSearchCompletelogloggermaxProvidersminProvidersnameprovidersrequestsaddEventListenerdispatchEventequalsevictfindNewProvidersfindProvidershasProviderisEvictedlistenerCountqueryProviderremoveEventListenerretrievesafeDispatchEventtoEvictionKey
\ No newline at end of file diff --git a/classes/_helia_utils.BloomFilter.html b/classes/_helia_utils.BloomFilter.html index b3daeb60..df37210b 100644 --- a/classes/_helia_utils.BloomFilter.html +++ b/classes/_helia_utils.BloomFilter.html @@ -1,4 +1,4 @@ -BloomFilter | Helia

Class BloomFilter

Constructors

constructor +BloomFilter | Helia

Class BloomFilter

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

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

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

  • 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

setbit

Static create

setbit

Static create

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbitcreate
\ No newline at end of file +

Parameters

Returns BloomFilter

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbitcreate
\ No newline at end of file diff --git a/classes/_helia_utils.Helia.html b/classes/_helia_utils.Helia.html index 0413b7d1..3d677153 100644 --- a/classes/_helia_utils.Helia.html +++ b/classes/_helia_utils.Helia.html @@ -1,5 +1,5 @@ Helia | Helia

Class Helia

The API presented by a Helia node

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

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

Methods

gc start stop -

Constructors

constructor

Properties

blockstore

blockstore: BlockStorage

Where the blocks are stored

-

dagWalkers

dagWalkers: Record<number, DAGWalker>

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

Constructors

constructor

Properties

blockstore

blockstore: BlockStorage

Where the blocks are stored

+

dagWalkers

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: 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: DNS

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

                      datastore

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

                                          hashers: Record<number, MultihashHasher<number>>

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

                                          hashers

                                          hashers: Record<number, MultihashHasher<number>>

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

                                          -

                                          Private Readonly log

                                          log: Logger

                                          logger

                                          logger: ComponentLogger

                                          A logging component that can be reused by consumers

                                          -

                                          Optional metrics

                                          metrics?: Metrics

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

                                          Private Readonly log

                                          log: Logger

                                          logger

                                          logger: ComponentLogger

                                          A logging component that can be reused by consumers

                                          +

                                          Optional metrics

                                          metrics?: Metrics

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

                                          -

                                          pins

                                          pins: Pins

                                          Pinning operations for blocks in the blockstore

                                          -

                                          routing

                                          routing: Routing

                                          The routing component allows performing operations such as looking up +

                                          pins

                                          pins: Pins

                                          Pinning operations for blocks in the blockstore

                                          +

                                          routing

                                          routing: Routing

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

                                          -

                                          Methods

                                          gc

                                          start

                                          stop

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          constructorblockstoredagWalkersdatastorednshasherslogloggermetricspinsroutinggcstartstop
                                          \ No newline at end of file +

                                          Methods

                                          gc

                                          start

                                          stop

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

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

                                          Function createBitswap

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +createBitswap | Helia

                                          Function createBitswap

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function bitswap

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns ((components) => BlockBroker)

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/_helia_block_brokers.trustlessGateway.html b/functions/_helia_block_brokers.trustlessGateway.html index b1707ea5..63d36e81 100644 --- a/functions/_helia_block_brokers.trustlessGateway.html +++ b/functions/_helia_block_brokers.trustlessGateway.html @@ -1 +1 @@ -trustlessGateway | Helia

                                          Function trustlessGateway

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +trustlessGateway | Helia

                                          Function trustlessGateway

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/_helia_car.car-1.html b/functions/_helia_car.car-1.html index f7ba4922..de0f9d46 100644 --- a/functions/_helia_car.car-1.html +++ b/functions/_helia_car.car-1.html @@ -1,2 +1,2 @@ car | Helia

                                          Function car

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Car

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ 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 803acc04..ff9e2933 100644 --- a/functions/_helia_dag_cbor.dagCbor-1.html +++ b/functions/_helia_dag_cbor.dagCbor-1.html @@ -1,2 +1,2 @@ dagCbor | Helia

                                          Function dagCbor

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns DAGCBOR

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ 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 a24cc17f..116d0c50 100644 --- a/functions/_helia_dag_json.dagJson-1.html +++ b/functions/_helia_dag_json.dagJson-1.html @@ -1,2 +1,2 @@ dagJson | Helia

                                          Function dagJson

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns DAGJSON

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function createHeliaHTTP

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Promise<Helia>

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ 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 2e7584bb..1b62bfa4 100644 --- a/functions/_helia_ipns.index.ipns-1.html +++ b/functions/_helia_ipns.index.ipns-1.html @@ -1 +1 @@ -ipns | Helia

                                          Function ipns

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +ipns | Helia

                                          Function ipns

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/_helia_ipns.routing.helia.html b/functions/_helia_ipns.routing.helia.html index 531ef241..664bcc9e 100644 --- a/functions/_helia_ipns.routing.helia.html +++ b/functions/_helia_ipns.routing.helia.html @@ -1,3 +1,3 @@ helia | Helia

                                          Function helia

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns IPNSRouting

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/_helia_ipns.routing.pubsub.html b/functions/_helia_ipns.routing.pubsub.html index 9229e386..d179dd3d 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

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns IPNSRouting

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function json

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns JSON

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function mfs

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns MFS

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function delegatedHTTPRouting

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Routing

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function httpGatewayRouting

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Partial<Routing>

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function libp2pRouting

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +libp2pRouting | Helia

                                          Function libp2pRouting

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function strings

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns Strings

                                          Settings

                                          Member Visibility

                                          Theme

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

                                          Function globSource

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns AsyncGenerator<ImportCandidate & GlobSourceResult>

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ 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 60a86794..43ca749a 100644 --- a/functions/_helia_unixfs.index.unixfs-1.html +++ b/functions/_helia_unixfs.index.unixfs-1.html @@ -1,2 +1,2 @@ unixfs | Helia

                                          Function unixfs

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Parameters

                                          Returns UnixFS

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/_helia_unixfs.index.urlSource.html b/functions/_helia_unixfs.index.urlSource.html index 8a46ff56..f6c8864b 100644 --- a/functions/_helia_unixfs.index.urlSource.html +++ b/functions/_helia_unixfs.index.urlSource.html @@ -1 +1 @@ -urlSource | Helia

                                          Function urlSource

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +urlSource | Helia

                                          Function urlSource

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/helia.createHelia.html b/functions/helia.createHelia.html index 93b6d350..2ec95e6d 100644 --- a/functions/helia.createHelia.html +++ b/functions/helia.createHelia.html @@ -1,2 +1,2 @@ createHelia | Helia

                                          Function createHelia

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +

                                          Type Parameters

                                          Parameters

                                          Returns Promise<HeliaLibp2p<T>>

                                        • createHelia(init?): Promise<HeliaLibp2p<Libp2p<DefaultLibp2pServices>>>

                                        • Parameters

                                          Returns Promise<HeliaLibp2p<Libp2p<DefaultLibp2pServices>>>

                                          • Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/functions/helia.libp2pDefaults.html b/functions/helia.libp2pDefaults.html index b6e3006e..17f16ec1 100644 --- a/functions/helia.libp2pDefaults.html +++ b/functions/helia.libp2pDefaults.html @@ -1 +1 @@ -libp2pDefaults | Helia

                                          Function libp2pDefaults

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file +libp2pDefaults | Helia

                                          Function libp2pDefaults

                                          Settings

                                          Member Visibility

                                          Theme

                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.Bitswap.html b/interfaces/_helia_bitswap.Bitswap.html index d6b107fd..44affbac 100644 --- a/interfaces/_helia_bitswap.Bitswap.html +++ b/interfaces/_helia_bitswap.Bitswap.html @@ -1,4 +1,4 @@ -Bitswap | Helia

                                          Interface Bitswap

                                          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

                                          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? afterStop? beforeStart? beforeStop? @@ -18,13 +18,13 @@

                                          Returns void | Promise<void>

                                          Optional beforeStop

                                          • beforeStop(): 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>

                                          createSession

                                          getPeerWantlist

                                          getPeerWantlist

                                          getWantlist

                                          notify

                                          start

                                          getWantlist

                                          notify

                                          start

                                          • start(): 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>

                                          stop

                                          • stop(): 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>

                                          want

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          afterStartafterStopbeforeStartbeforeStopcreateSessiongetPeerWantlistgetWantlistnotifystartstopwant
                                          \ No newline at end of file +

                                          Parameters

                                          Returns Promise<Uint8Array>

                                          Settings

                                          Member Visibility

                                          Theme

                                          On This Page

                                          afterStartafterStopbeforeStartbeforeStopcreateSessiongetPeerWantlistgetWantlistnotifystartstopwant
                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.BitswapComponents.html b/interfaces/_helia_bitswap.BitswapComponents.html index 7ecad467..24f38015 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 libp2p logger metrics? routing -

                                          Properties

                                          blockstore

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

                                          Type declaration

                                            Type declaration

                                              Type declaration

                                                Type declaration

                                                  Type declaration

                                                    Type declaration

                                                      Type declaration

                                                        Type declaration

                                                          libp2p

                                                          libp2p: Libp2p<ServiceMap>

                                                          logger

                                                          logger: ComponentLogger

                                                          Optional metrics

                                                          metrics?: Metrics

                                                          routing

                                                          routing: Routing

                                                          Settings

                                                          Member Visibility

                                                          Theme

                                                          On This Page

                                                          blockstorelibp2ploggermetricsrouting
                                                          \ No newline at end of file +

                                                          Properties

                                                          blockstore

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

                                                          Type declaration

                                                            Type declaration

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          libp2p

                                                                          libp2p: Libp2p<ServiceMap>

                                                                          logger

                                                                          logger: ComponentLogger

                                                                          Optional metrics

                                                                          metrics?: Metrics

                                                                          routing

                                                                          routing: Routing

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          blockstorelibp2ploggermetricsrouting
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.BitswapOptions.html b/interfaces/_helia_bitswap.BitswapOptions.html index 0e7cbaca..e8da8946 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

                                                                          hashLoader? incomingStreamTimeout? maxInboundStreams? maxIncomingMessageSize? @@ -12,54 +12,54 @@ sendBlocksDebounce? sendBlocksTimeout?

                                                                          Properties

                                                                          Optional hashLoader

                                                                          hashLoader?: MultihashHasherLoader

                                                                          Enables loading esoteric hash functions

                                                                          -

                                                                          Optional incomingStreamTimeout

                                                                          incomingStreamTimeout?: number

                                                                          An incoming stream must resolve within this number of seconds

                                                                          +

                                                                          Optional incomingStreamTimeout

                                                                          incomingStreamTimeout?: number

                                                                          An incoming stream must resolve within this number of seconds

                                                                          Default

                                                                          30000
                                                                          -

                                                                          Optional maxInboundStreams

                                                                          maxInboundStreams?: number

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

                                                                          Optional maxInboundStreams

                                                                          maxInboundStreams?: number

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

                                                                          Default

                                                                          32
                                                                          -

                                                                          Optional maxIncomingMessageSize

                                                                          maxIncomingMessageSize?: number

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

                                                                          +

                                                                          Optional maxIncomingMessageSize

                                                                          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
                                                                          -

                                                                          Optional maxOutboundStreams

                                                                          maxOutboundStreams?: number

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

                                                                          Optional maxOutboundStreams

                                                                          maxOutboundStreams?: number

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

                                                                          Default

                                                                          128
                                                                          -

                                                                          Optional maxOutgoingMessageSize

                                                                          maxOutgoingMessageSize?: number

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

                                                                          Optional maxOutgoingMessageSize

                                                                          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.

                                                                          See

                                                                          https://github.com/ipfs/boxo/blob/eeea414587350401b6b804f0574ed8436833331d/bitswap/client/internal/messagequeue/messagequeue.go#L33

                                                                          Default

                                                                          2097152
                                                                          -

                                                                          Optional maxSizeReplaceHasWithBlock

                                                                          maxSizeReplaceHasWithBlock?: number

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

                                                                          Optional maxSizeReplaceHasWithBlock

                                                                          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
                                                                          -

                                                                          Optional messageSendConcurrency

                                                                          messageSendConcurrency?: number

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

                                                                          +

                                                                          Optional messageSendConcurrency

                                                                          messageSendConcurrency?: number

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

                                                                          Default

                                                                          50
                                                                          -

                                                                          Optional protocol

                                                                          protocol?: string

                                                                          The protocol that we speak

                                                                          +

                                                                          Optional protocol

                                                                          protocol?: string

                                                                          The protocol that we speak

                                                                          Default

                                                                          '/ipfs/bitswap/1.2.0'
                                                                          -

                                                                          Optional runOnTransientConnections

                                                                          runOnTransientConnections?: boolean

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

                                                                          +

                                                                          Optional runOnTransientConnections

                                                                          runOnTransientConnections?: boolean

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

                                                                          Default

                                                                          false
                                                                          -

                                                                          Optional sendBlocksConcurrency

                                                                          sendBlocksConcurrency?: number

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

                                                                          +

                                                                          Optional sendBlocksConcurrency

                                                                          sendBlocksConcurrency?: number

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

                                                                          Default

                                                                          50
                                                                          -

                                                                          Optional sendBlocksDebounce

                                                                          sendBlocksDebounce?: number

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

                                                                          Optional sendBlocksDebounce

                                                                          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
                                                                          -

                                                                          Optional sendBlocksTimeout

                                                                          sendBlocksTimeout?: number

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

                                                                          Optional sendBlocksTimeout

                                                                          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
                                                                          -

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          hashLoaderincomingStreamTimeoutmaxInboundStreamsmaxIncomingMessageSizemaxOutboundStreamsmaxOutgoingMessageSizemaxSizeReplaceHasWithBlockmessageSendConcurrencyprotocolrunOnTransientConnectionssendBlocksConcurrencysendBlocksDebouncesendBlocksTimeout
                                                                          \ No newline at end of file +

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          hashLoaderincomingStreamTimeoutmaxInboundStreamsmaxIncomingMessageSizemaxOutboundStreamsmaxOutgoingMessageSizemaxSizeReplaceHasWithBlockmessageSendConcurrencyprotocolrunOnTransientConnectionssendBlocksConcurrencysendBlocksDebouncesendBlocksTimeout
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.MultihashHasherLoader.html b/interfaces/_helia_bitswap.MultihashHasherLoader.html index 584771bf..89a393aa 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

                                                                          getHasher -

                                                                          Methods

                                                                          getHasher

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          getHasher
                                                                          \ No newline at end of file +MultihashHasherLoader | Helia

                                                                          Interface MultihashHasherLoader

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

                                                                          Methods

                                                                          getHasher +

                                                                          Methods

                                                                          getHasher

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          getHasher
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_bitswap.WantListEntry.html b/interfaces/_helia_bitswap.WantListEntry.html index 21d1d12e..e32bddf0 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

                                                                          cid priority wantType -

                                                                          Properties

                                                                          cid

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

                                                                          priority

                                                                          priority: number

                                                                          wantType

                                                                          wantType: WantType

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          cidprioritywantType
                                                                          \ No newline at end of file +

                                                                          Properties

                                                                          cid

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

                                                                          priority

                                                                          priority: number

                                                                          wantType

                                                                          wantType: WantType

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          cidprioritywantType
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_car.Car.html b/interfaces/_helia_car.Car.html index efd96a5d..2876b616 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

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

                                                                          Methods

                                                                          export import stream

                                                                          Methods

                                                                          export

                                                                          • export(root, writer, options?): Promise<void>

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

                                                                          import

                                                                          • import(reader, options?): Promise<void>

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

                                                                            +

                                                                          import

                                                                          • import(reader, options?): Promise<void>

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

                                                                          stream

                                                                          stream

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          exportimportstream
                                                                          \ No newline at end of file +

                                                                          Settings

                                                                          Member Visibility

                                                                          Theme

                                                                          On This Page

                                                                          exportimportstream
                                                                          \ No newline at end of file diff --git a/interfaces/_helia_car.CarComponents.html b/interfaces/_helia_car.CarComponents.html index e262a7da..bc1e9d5f 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 dagWalkers -

                                                                          Properties

                                                                          blockstore

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

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          dagWalkers

                                                                                          dagWalkers: Record<number, DAGWalker>

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          Theme

                                                                                          On This Page

                                                                                          blockstoredagWalkers
                                                                                          \ No newline at end of file +

                                                                                          Properties

                                                                                          blockstore

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

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          dagWalkers

                                                                                                          dagWalkers: Record<number, DAGWalker>

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          Theme

                                                                                                          On This Page

                                                                                                          blockstoredagWalkers
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.AddOptions.html b/interfaces/_helia_dag_cbor.AddOptions.html index ce0c9078..706c8b0f 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 onProgress? signal? -

                                                                                                          Properties

                                                                                                          hasher

                                                                                                          hasher: MultihashHasher<number>

                                                                                                          Optional onProgress

                                                                                                          onProgress?: ((evt) => void)

                                                                                                          Type declaration

                                                                                                          Optional signal

                                                                                                          signal?: AbortSignal

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          Theme

                                                                                                          On This Page

                                                                                                          hasheronProgresssignal
                                                                                                          \ No newline at end of file +

                                                                                                          Properties

                                                                                                          hasher

                                                                                                          hasher: MultihashHasher<number>

                                                                                                          Optional onProgress

                                                                                                          onProgress?: ((evt) => void)

                                                                                                          Type declaration

                                                                                                          Optional signal

                                                                                                          signal?: AbortSignal

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          Theme

                                                                                                          On This Page

                                                                                                          hasheronProgresssignal
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.DAGCBOR.html b/interfaces/_helia_dag_cbor.DAGCBOR.html index a07b6db1..5f7cf951 100644 --- a/interfaces/_helia_dag_cbor.DAGCBOR.html +++ b/interfaces/_helia_dag_cbor.DAGCBOR.html @@ -1,13 +1,13 @@ DAGCBOR | Helia

                                                                                                          Interface DAGCBOR

                                                                                                          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

                                                                                                          add get

                                                                                                          Methods

                                                                                                          add

                                                                                                          • add(str, options?): Promise<CID<unknown, number, number, Version>>

                                                                                                          • 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

                                                                                                          get

                                                                                                          • get<T>(cid, options?): Promise<T>

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

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          Theme

                                                                                                          On This Page

                                                                                                          addget
                                                                                                          \ No newline at end of file +

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          Theme

                                                                                                          On This Page

                                                                                                          addget
                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.DAGCBORComponents.html b/interfaces/_helia_dag_cbor.DAGCBORComponents.html index a70df857..e5d08712 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

                                                                                                          blockstore -

                                                                                                          Properties

                                                                                                          blockstore

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

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  Type declaration

                                                                                                                    Type declaration

                                                                                                                      Type declaration

                                                                                                                        Type declaration

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          Theme

                                                                                                                          On This Page

                                                                                                                          blockstore
                                                                                                                          \ No newline at end of file +DAGCBORComponents | Helia

                                                                                                                          Interface DAGCBORComponents

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

                                                                                                                          Properties

                                                                                                                          blockstore +

                                                                                                                          Properties

                                                                                                                          blockstore

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

                                                                                                                          Type declaration

                                                                                                                            Type declaration

                                                                                                                              Type declaration

                                                                                                                                Type declaration

                                                                                                                                  Type declaration

                                                                                                                                    Type declaration

                                                                                                                                      Type declaration

                                                                                                                                        Type declaration

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          blockstore
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_cbor.GetOptions.html b/interfaces/_helia_dag_cbor.GetOptions.html index 93a3fc34..f4f9f044 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 onProgress? signal? -

                                                                                                                                          Properties

                                                                                                                                          codec

                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                          Optional onProgress

                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          Optional signal

                                                                                                                                          signal?: AbortSignal

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          codeconProgresssignal
                                                                                                                                          \ No newline at end of file +

                                                                                                                                          Properties

                                                                                                                                          codec

                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                          Optional onProgress

                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          Optional signal

                                                                                                                                          signal?: AbortSignal

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          codeconProgresssignal
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.AddOptions.html b/interfaces/_helia_dag_json.AddOptions.html index da57083b..36097e72 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 onProgress? signal? -

                                                                                                                                          Properties

                                                                                                                                          hasher

                                                                                                                                          hasher: MultihashHasher<number>

                                                                                                                                          Optional onProgress

                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          Optional signal

                                                                                                                                          signal?: AbortSignal

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          hasheronProgresssignal
                                                                                                                                          \ No newline at end of file +

                                                                                                                                          Properties

                                                                                                                                          hasher

                                                                                                                                          hasher: MultihashHasher<number>

                                                                                                                                          Optional onProgress

                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                          Type declaration

                                                                                                                                          Optional signal

                                                                                                                                          signal?: AbortSignal

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          hasheronProgresssignal
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.DAGJSON.html b/interfaces/_helia_dag_json.DAGJSON.html index 325e6961..37ad3e73 100644 --- a/interfaces/_helia_dag_json.DAGJSON.html +++ b/interfaces/_helia_dag_json.DAGJSON.html @@ -1,13 +1,13 @@ DAGJSON | Helia

                                                                                                                                          Interface DAGJSON

                                                                                                                                          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

                                                                                                                                          add get

                                                                                                                                          Methods

                                                                                                                                          add

                                                                                                                                          • add(str, options?): Promise<CID<unknown, number, number, Version>>

                                                                                                                                          • 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

                                                                                                                                          get

                                                                                                                                          • get<T>(cid, options?): Promise<T>

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

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          addget
                                                                                                                                          \ No newline at end of file +

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          Theme

                                                                                                                                          On This Page

                                                                                                                                          addget
                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.DAGJSONComponents.html b/interfaces/_helia_dag_json.DAGJSONComponents.html index 0b8a26f0..f01c5826 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

                                                                                                                                          blockstore -

                                                                                                                                          Properties

                                                                                                                                          blockstore

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

                                                                                                                                          Type declaration

                                                                                                                                            Type declaration

                                                                                                                                              Type declaration

                                                                                                                                                Type declaration

                                                                                                                                                  Type declaration

                                                                                                                                                    Type declaration

                                                                                                                                                      Type declaration

                                                                                                                                                        Type declaration

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          Theme

                                                                                                                                                          On This Page

                                                                                                                                                          blockstore
                                                                                                                                                          \ No newline at end of file +DAGJSONComponents | Helia

                                                                                                                                                          Interface DAGJSONComponents

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

                                                                                                                                                          Properties

                                                                                                                                                          blockstore +

                                                                                                                                                          Properties

                                                                                                                                                          blockstore

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

                                                                                                                                                          Type declaration

                                                                                                                                                            Type declaration

                                                                                                                                                              Type declaration

                                                                                                                                                                Type declaration

                                                                                                                                                                  Type declaration

                                                                                                                                                                    Type declaration

                                                                                                                                                                      Type declaration

                                                                                                                                                                        Type declaration

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          blockstore
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_dag_json.GetOptions.html b/interfaces/_helia_dag_json.GetOptions.html index 6a561866..a32c30b7 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 onProgress? signal? -

                                                                                                                                                                          Properties

                                                                                                                                                                          codec

                                                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                                                          Optional onProgress

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          Optional signal

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          codeconProgresssignal
                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Properties

                                                                                                                                                                          codec

                                                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                                                          Optional onProgress

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          Optional signal

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          codeconProgresssignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_http.HeliaHTTPInit.html b/interfaces/_helia_http.HeliaHTTPInit.html index f4ba2f88..c7177983 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

                                                                                                                                                                          blockBrokers +
                                                                                                                                                                          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

                                                                                                                                                                          blockBrokers blockstore components? dagWalkers? @@ -51,4 +51,4 @@

                                                                                                                                                                          Optional routers

                                                                                                                                                                          routers?: Partial<Routing>[]

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

                                                                                                                                                                          Optional start

                                                                                                                                                                          start?: boolean

                                                                                                                                                                          Whether to start the Helia node

                                                                                                                                                                          -

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockloggermetricsproviderLookupConcurrencyroutersstart
                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockloggermetricsproviderLookupConcurrencyroutersstart
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html b/interfaces/_helia_interface.blocks.BlockAnnounceOptions.html index 64a3cb69..98b3c3ab 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

                                                                                                                                                                          onProgress? signal?

                                                                                                                                                                          Properties

                                                                                                                                                                          Optional onProgress

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          Optional signal

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          onProgresssignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockBroker.html b/interfaces/_helia_interface.blocks.BlockBroker.html index 1e523a79..211c7436 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

                                                                                                                                                                          announce? createSession? retrieve?

                                                                                                                                                                          Methods

                                                                                                                                                                          Optional announce

                                                                                                                                                                          Optional createSession

                                                                                                                                                                          Optional retrieve

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          announcecreateSessionretrieve
                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                          Optional createSession

                                                                                                                                                                          Optional retrieve

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          announcecreateSessionretrieve
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html b/interfaces/_helia_interface.blocks.BlockRetrievalOptions.html index 4b032cc7..b74145ed 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

                                                                                                                                                                          onProgress? signal?

                                                                                                                                                                          Methods

                                                                                                                                                                          validateFn?

                                                                                                                                                                          Properties

                                                                                                                                                                          Optional onProgress

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                          Optional signal

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Methods

                                                                                                                                                                          Optional validateFn

                                                                                                                                                                          • validateFn(block): Promise<void>

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

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          onProgresssignalvalidateFn
                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          onProgresssignalvalidateFn
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.Blocks.html b/interfaces/_helia_interface.blocks.Blocks.html index 69b2b210..252d4c92 100644 --- a/interfaces/_helia_interface.blocks.Blocks.html +++ b/interfaces/_helia_interface.blocks.Blocks.html @@ -1,4 +1,4 @@ -Blocks | Helia

                                                                                                                                                                          Interface Blocks

                                                                                                                                                                          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

                                                                                                                                                                          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 delete deleteMany get @@ -7,7 +7,7 @@ has put putMany -

                                                                                                                                                                          Methods

                                                                                                                                                                          createSession

                                                                                                                                                                          delete

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

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            +

                                                                                                                                                                          Methods

                                                                                                                                                                          createSession

                                                                                                                                                                          delete

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

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns Await<void>

                                                                                                                                                                            Example

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

                                                                                                                                                                          deleteMany

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

                                                                                                                                                                          • Remove values for the passed keys

                                                                                                                                                                            diff --git a/interfaces/_helia_interface.blocks.CreateSessionOptions.html b/interfaces/_helia_interface.blocks.CreateSessionOptions.html index 51b7e10a..cd47581a 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? minProviders? onProgress? signal?

                                                                                                                                                                            Properties

                                                                                                                                                                            Optional maxProviders

                                                                                                                                                                            maxProviders?: number

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

                                                                                                                                                                            Default

                                                                                                                                                                            5
                                                                                                                                                                            -

                                                                                                                                                                            Optional minProviders

                                                                                                                                                                            minProviders?: number

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

                                                                                                                                                                            Optional minProviders

                                                                                                                                                                            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
                                                                                                                                                                            -

                                                                                                                                                                            Optional onProgress

                                                                                                                                                                            onProgress?: ((evt) => void)

                                                                                                                                                                            Type declaration

                                                                                                                                                                            Optional signal

                                                                                                                                                                            signal?: AbortSignal

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            maxProvidersminProvidersonProgresssignal
                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                            Optional onProgress

                                                                                                                                                                            onProgress?: ((evt) => void)

                                                                                                                                                                            Type declaration

                                                                                                                                                                            Optional signal

                                                                                                                                                                            signal?: AbortSignal

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            maxProvidersminProvidersonProgresssignal
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.GetOfflineOptions.html b/interfaces/_helia_interface.blocks.GetOfflineOptions.html index 136f7d35..4051a63e 100644 --- a/interfaces/_helia_interface.blocks.GetOfflineOptions.html +++ b/interfaces/_helia_interface.blocks.GetOfflineOptions.html @@ -1,5 +1,5 @@ -GetOfflineOptions | Helia

                                                                                                                                                                            Interface GetOfflineOptions

                                                                                                                                                                            interface GetOfflineOptions {
                                                                                                                                                                                offline?: boolean;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            offline? +GetOfflineOptions | Helia

                                                                                                                                                                            Interface GetOfflineOptions

                                                                                                                                                                            interface GetOfflineOptions {
                                                                                                                                                                                offline?: boolean;
                                                                                                                                                                            }

                                                                                                                                                                            Properties

                                                                                                                                                                            offline?

                                                                                                                                                                            Properties

                                                                                                                                                                            Optional offline

                                                                                                                                                                            offline?: boolean

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

                                                                                                                                                                            Default

                                                                                                                                                                            false
                                                                                                                                                                            -

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            offline
                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            offline
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.Pair.html b/interfaces/_helia_interface.blocks.Pair.html index 9f215ccf..bf976c8c 100644 --- a/interfaces/_helia_interface.blocks.Pair.html +++ b/interfaces/_helia_interface.blocks.Pair.html @@ -1,3 +1,3 @@ -Pair | Helia

                                                                                                                                                                            Interface Pair

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

                                                                                                                                                                            Properties

                                                                                                                                                                            block +Pair | Helia

                                                                                                                                                                            Interface Pair

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

                                                                                                                                                                            Properties

                                                                                                                                                                            block cid -

                                                                                                                                                                            Properties

                                                                                                                                                                            block

                                                                                                                                                                            block: Uint8Array

                                                                                                                                                                            cid

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

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            blockcid
                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                            Properties

                                                                                                                                                                            block

                                                                                                                                                                            block: Uint8Array

                                                                                                                                                                            cid

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

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            On This Page

                                                                                                                                                                            blockcid
                                                                                                                                                                            \ No newline at end of file diff --git a/interfaces/_helia_interface.blocks.SessionBlockstore.html b/interfaces/_helia_interface.blocks.SessionBlockstore.html index 1b8e53b0..26d1da12 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

                                                                                                                                                                          close +
                                                                                                                                                                          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

                                                                                                                                                                          close

                                                                                                                                                                          delete

                                                                                                                                                                          delete

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

                                                                                                                                                                          • Remove the record for the passed key

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns Await<void>

                                                                                                                                                                            Example

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

                                                                                                                                                                          deleteMany

                                                                                                                                                                          Properties

                                                                                                                                                                          codec

                                                                                                                                                                          codec: number

                                                                                                                                                                          Methods

                                                                                                                                                                          walk

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          codecwalk
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.index.GCOptions.html b/interfaces/_helia_interface.index.GCOptions.html index 760b1414..5b876254 100644 --- a/interfaces/_helia_interface.index.GCOptions.html +++ b/interfaces/_helia_interface.index.GCOptions.html @@ -1,3 +1,3 @@ -GCOptions | Helia

                                                                                                                                                                          Interface GCOptions

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

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress? +GCOptions | Helia

                                                                                                                                                                          Interface GCOptions

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

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          Properties

                                                                                                                                                                          onProgress? signal?

                                                                                                                                                                          Properties

                                                                                                                                                                          Optional onProgress

                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                          Type declaration

                                                                                                                                                                            • (evt): void

                                                                                                                                                                            • Parameters

                                                                                                                                                                              Returns void

                                                                                                                                                                          Optional signal

                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          Theme

                                                                                                                                                                          On This Page

                                                                                                                                                                          onProgresssignal
                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_interface.index.Helia.html b/interfaces/_helia_interface.index.Helia.html index 19232e8e..5eca521a 100644 --- a/interfaces/_helia_interface.index.Helia.html +++ b/interfaces/_helia_interface.index.Helia.html @@ -1,5 +1,5 @@ Helia | Helia

                                                                                                                                                                          Interface 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

                                                                                                                                                                          blockstore +
                                                                                                                                                                          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

                                                                                                                                                                          blockstore dagWalkers datastore dns @@ -12,20 +12,20 @@ start stop

                                                                                                                                                                          Properties

                                                                                                                                                                          blockstore

                                                                                                                                                                          blockstore: Blocks

                                                                                                                                                                          Where the blocks are stored

                                                                                                                                                                          -

                                                                                                                                                                          dagWalkers

                                                                                                                                                                          dagWalkers: Record<number, DAGWalker>

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

                                                                                                                                                                          dagWalkers

                                                                                                                                                                          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: 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: DNS

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

                                                                                                                                                                                              datastore

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

                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>

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

                                                                                                                                                                                                                  hashers

                                                                                                                                                                                                                  hashers: Record<number, MultihashHasher<number>>

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

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  logger

                                                                                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                                                                                  A logging component that can be reused by consumers

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Optional metrics

                                                                                                                                                                                                                  metrics?: Metrics

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

                                                                                                                                                                                                                  logger

                                                                                                                                                                                                                  logger: ComponentLogger

                                                                                                                                                                                                                  A logging component that can be reused by consumers

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Optional metrics

                                                                                                                                                                                                                  metrics?: Metrics

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

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  pins

                                                                                                                                                                                                                  pins: Pins

                                                                                                                                                                                                                  Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  routing

                                                                                                                                                                                                                  routing: Routing

                                                                                                                                                                                                                  The routing component allows performing operations such as looking up +

                                                                                                                                                                                                                  pins

                                                                                                                                                                                                                  pins: Pins

                                                                                                                                                                                                                  Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  routing

                                                                                                                                                                                                                  routing: Routing

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

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  gc

                                                                                                                                                                                                                  start

                                                                                                                                                                                                                  stop

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  blockstoredagWalkersdatastorednshashersloggermetricspinsroutinggcstartstop
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  gc

                                                                                                                                                                                                                  start

                                                                                                                                                                                                                  stop

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

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

                                                                                                                                                                                                                  Interface Provider

                                                                                                                                                                                                                  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 multiaddrs protocols?

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  id

                                                                                                                                                                                                                  id: PeerId

                                                                                                                                                                                                                  The identifier of the remote peer

                                                                                                                                                                                                                  @@ -13,4 +13,4 @@
                                                                                                                                                                                                                • transport-ipfs-gateway-http
                                                                                                                                                                                                                • transport-bitswap
                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  idmultiaddrsprotocols
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  idmultiaddrsprotocols
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.index.Routing.html b/interfaces/_helia_interface.index.Routing.html index 7d8511ba..e1371603 100644 --- a/interfaces/_helia_interface.index.Routing.html +++ b/interfaces/_helia_interface.index.Routing.html @@ -1,4 +1,4 @@ -Routing | Helia

                                                                                                                                                                                                                  Interface Routing

                                                                                                                                                                                                                  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

                                                                                                                                                                                                                  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 findProviders get getClosestPeers @@ -7,22 +7,22 @@

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  findPeer

                                                                                                                                                                                                                  findProviders

                                                                                                                                                                                                                  findProviders

                                                                                                                                                                                                                  • findProviders(cid, options?): AsyncIterable<Provider>

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

                                                                                                                                                                                                                  get

                                                                                                                                                                                                                  get

                                                                                                                                                                                                                  getClosestPeers

                                                                                                                                                                                                                  getClosestPeers

                                                                                                                                                                                                                  • getClosestPeers(key, options?): AsyncIterable<PeerInfo>

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

                                                                                                                                                                                                                  provide

                                                                                                                                                                                                                  provide

                                                                                                                                                                                                                  • provide(cid, options?): Promise<void>

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

                                                                                                                                                                                                                  put

                                                                                                                                                                                                                  put

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

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

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  findPeerfindProvidersgetgetClosestPeersprovideput
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  findPeerfindProvidersgetgetClosestPeersprovideput
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.index.RoutingOptions.html b/interfaces/_helia_interface.index.RoutingOptions.html index c455d1f7..33972a5c 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

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

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  onProgress? signal? useCache? useNetwork? @@ -10,10 +10,10 @@

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                      • evt: any

                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Optional useCache

                                                                                                                                                                                                                  useCache?: boolean

                                                                                                                                                                                                                  Pass false to not use cached values

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Optional useNetwork

                                                                                                                                                                                                                  useNetwork?: boolean

                                                                                                                                                                                                                  Pass false to not use the network

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Optional useNetwork

                                                                                                                                                                                                                  useNetwork?: boolean

                                                                                                                                                                                                                  Pass false to not use the network

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Optional validate

                                                                                                                                                                                                                  validate?: boolean

                                                                                                                                                                                                                  Pass false to not perform validation

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Optional validate

                                                                                                                                                                                                                  validate?: boolean

                                                                                                                                                                                                                  Pass false to not perform validation

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  true
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  onProgresssignaluseCacheuseNetworkvalidate
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  onProgresssignaluseCacheuseNetworkvalidate
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.AddOptions.html b/interfaces/_helia_interface.pins.AddOptions.html index 8f886fb1..6abb8610 100644 --- a/interfaces/_helia_interface.pins.AddOptions.html +++ b/interfaces/_helia_interface.pins.AddOptions.html @@ -1,7 +1,7 @@ -AddOptions | Helia

                                                                                                                                                                                                                  Interface AddOptions

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

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  depth? +AddOptions | Helia

                                                                                                                                                                                                                  Interface AddOptions

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

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  depth? metadata? onProgress? signal?

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional depth

                                                                                                                                                                                                                  depth?: number

                                                                                                                                                                                                                  How deeply to pin the DAG, defaults to Infinity

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Optional metadata

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

                                                                                                                                                                                                                  Optional user-defined metadata to store with the pin

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  depthmetadataonProgresssignal
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Optional metadata

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

                                                                                                                                                                                                                  Optional user-defined metadata to store with the pin

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  depthmetadataonProgresssignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.IsPinnedOptions.html b/interfaces/_helia_interface.pins.IsPinnedOptions.html index 607cdacc..215d6863 100644 --- a/interfaces/_helia_interface.pins.IsPinnedOptions.html +++ b/interfaces/_helia_interface.pins.IsPinnedOptions.html @@ -1,2 +1,2 @@ -IsPinnedOptions | Helia

                                                                                                                                                                                                                  Interface IsPinnedOptions

                                                                                                                                                                                                                  interface IsPinnedOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal? +IsPinnedOptions | Helia

                                                                                                                                                                                                                  Interface IsPinnedOptions

                                                                                                                                                                                                                  interface IsPinnedOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal?

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  signal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.LsOptions.html b/interfaces/_helia_interface.pins.LsOptions.html index bec7d544..9548584b 100644 --- a/interfaces/_helia_interface.pins.LsOptions.html +++ b/interfaces/_helia_interface.pins.LsOptions.html @@ -1,3 +1,3 @@ -LsOptions | Helia

                                                                                                                                                                                                                  Interface LsOptions

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

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid? +LsOptions | Helia

                                                                                                                                                                                                                  Interface LsOptions

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

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid? signal? -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional cid

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

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  cidsignal
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional cid

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

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  cidsignal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.Pin.html b/interfaces/_helia_interface.pins.Pin.html index 63845c45..f79b0d42 100644 --- a/interfaces/_helia_interface.pins.Pin.html +++ b/interfaces/_helia_interface.pins.Pin.html @@ -1,4 +1,4 @@ -Pin | Helia

                                                                                                                                                                                                                  Interface Pin

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

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid +Pin | Helia

                                                                                                                                                                                                                  Interface Pin

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

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid depth metadata -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid

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

                                                                                                                                                                                                                  depth

                                                                                                                                                                                                                  depth: number

                                                                                                                                                                                                                  metadata

                                                                                                                                                                                                                  metadata: Record<string, any>

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  ciddepthmetadata
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  cid

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

                                                                                                                                                                                                                  depth

                                                                                                                                                                                                                  depth: number

                                                                                                                                                                                                                  metadata

                                                                                                                                                                                                                  metadata: Record<string, any>

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  ciddepthmetadata
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.Pins.html b/interfaces/_helia_interface.pins.Pins.html index 4a234932..e4f90ac0 100644 --- a/interfaces/_helia_interface.pins.Pins.html +++ b/interfaces/_helia_interface.pins.Pins.html @@ -1,11 +1,11 @@ -Pins | Helia

                                                                                                                                                                                                                  Interface Pins

                                                                                                                                                                                                                  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

                                                                                                                                                                                                                  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 isPinned ls rm

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  add

                                                                                                                                                                                                                  isPinned

                                                                                                                                                                                                                  ls

                                                                                                                                                                                                                  rm

                                                                                                                                                                                                                  isPinned

                                                                                                                                                                                                                  ls

                                                                                                                                                                                                                  rm

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  addisPinnedlsrm
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Parameters

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

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  addisPinnedlsrm
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_interface.pins.RmOptions.html b/interfaces/_helia_interface.pins.RmOptions.html index 798073d6..545dbc72 100644 --- a/interfaces/_helia_interface.pins.RmOptions.html +++ b/interfaces/_helia_interface.pins.RmOptions.html @@ -1,2 +1,2 @@ -RmOptions | Helia

                                                                                                                                                                                                                  Interface RmOptions

                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal? +RmOptions | Helia

                                                                                                                                                                                                                  Interface RmOptions

                                                                                                                                                                                                                  interface RmOptions {
                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  signal?

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  signal
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.DNSLinkResolveResult.html b/interfaces/_helia_ipns.index.DNSLinkResolveResult.html index 4f925ca7..df35a4cc 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

                                                                                                                                                                                                                  answer cid path

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  answer

                                                                                                                                                                                                                  answer: Answer

                                                                                                                                                                                                                  The resolved record

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  cid

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

                                                                                                                                                                                                                  The CID that was resolved

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  path

                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                  Any path component that was part of the resolved record

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  cid

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

                                                                                                                                                                                                                  The CID that was resolved

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  path

                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                  Any path component that was part of the resolved record

                                                                                                                                                                                                                  Default

                                                                                                                                                                                                                  ""
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  answercidpath
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  answercidpath
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNS.html b/interfaces/_helia_ipns.index.IPNS.html index b83b5ba6..e4b8c7e8 100644 --- a/interfaces/_helia_ipns.index.IPNS.html +++ b/interfaces/_helia_ipns.index.IPNS.html @@ -1,11 +1,11 @@ -IPNS | Helia

                                                                                                                                                                                                                  Interface IPNS

                                                                                                                                                                                                                  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

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

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  publish republish resolve resolveDNSLink

                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                  publish

                                                                                                                                                                                                                  republish

                                                                                                                                                                                                                  resolve

                                                                                                                                                                                                                  republish

                                                                                                                                                                                                                  resolve

                                                                                                                                                                                                                  resolveDNSLink

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  publishrepublishresolveresolveDNSLink
                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Returns Promise<IPNSResolveResult>

                                                                                                                                                                                                                  resolveDNSLink

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  publishrepublishresolveresolveDNSLink
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSComponents.html b/interfaces/_helia_ipns.index.IPNSComponents.html index 90314e7b..46b8f28a 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 dns logger routing -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  datastore

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

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                      dns

                                                                                                                                                                                                                                      dns: DNS

                                                                                                                                                                                                                                      logger

                                                                                                                                                                                                                                      logger: ComponentLogger

                                                                                                                                                                                                                                      routing

                                                                                                                                                                                                                                      routing: Routing

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      datastorednsloggerrouting
                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      datastore

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

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                          dns

                                                                                                                                                                                                                                                          dns: DNS

                                                                                                                                                                                                                                                          logger

                                                                                                                                                                                                                                                          logger: ComponentLogger

                                                                                                                                                                                                                                                          routing

                                                                                                                                                                                                                                                          routing: Routing

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          datastorednsloggerrouting
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSOptions.html b/interfaces/_helia_ipns.index.IPNSOptions.html index 63f1a961..82fbb0fe 100644 --- a/interfaces/_helia_ipns.index.IPNSOptions.html +++ b/interfaces/_helia_ipns.index.IPNSOptions.html @@ -1,2 +1,2 @@ -IPNSOptions | Helia

                                                                                                                                                                                                                                                          Interface IPNSOptions

                                                                                                                                                                                                                                                          interface IPNSOptions {
                                                                                                                                                                                                                                                              routers?: IPNSRouting[];
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          routers? -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional routers

                                                                                                                                                                                                                                                          routers?: IPNSRouting[]

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          routers
                                                                                                                                                                                                                                                          \ No newline at end of file +IPNSOptions | Helia

                                                                                                                                                                                                                                                          Interface IPNSOptions

                                                                                                                                                                                                                                                          interface IPNSOptions {
                                                                                                                                                                                                                                                              routers?: IPNSRouting[];
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          routers? +

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional routers

                                                                                                                                                                                                                                                          routers?: IPNSRouting[]

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          routers
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.IPNSResolveResult.html b/interfaces/_helia_ipns.index.IPNSResolveResult.html index 211f4610..f0947142 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

                                                                                                                                                                                                                                                          cid path record

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid

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

                                                                                                                                                                                                                                                          The CID that was resolved

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          path

                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          path

                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          ""
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          record

                                                                                                                                                                                                                                                          record: IPNSRecord

                                                                                                                                                                                                                                                          The resolved record

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          cidpathrecord
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          record

                                                                                                                                                                                                                                                          record: IPNSRecord

                                                                                                                                                                                                                                                          The resolved record

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          cidpathrecord
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.PublishOptions.html b/interfaces/_helia_ipns.index.PublishOptions.html index 440c77a0..0586f915 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? offline? onProgress? signal? v1Compatible?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional lifetime

                                                                                                                                                                                                                                                          lifetime?: number

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

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Only publish to a local datastore (default: false)

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Optional v1Compatible

                                                                                                                                                                                                                                                          v1Compatible?: boolean

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

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Only publish to a local datastore (default: false)

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Optional v1Compatible

                                                                                                                                                                                                                                                          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)

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          lifetimeofflineonProgresssignalv1Compatible
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          lifetimeofflineonProgresssignalv1Compatible
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.RepublishOptions.html b/interfaces/_helia_ipns.index.RepublishOptions.html index eee14a49..906eb2fe 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? onProgress? signal?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional interval

                                                                                                                                                                                                                                                          interval?: number

                                                                                                                                                                                                                                                          The republish interval in ms (default: 23hrs)

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          intervalonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          intervalonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html b/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html index 72f94c0e..f39229fc 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
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional nocache

                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached DNS entries

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Optional nocache

                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached DNS entries

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          maxRecursiveDepthnocacheofflineonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          maxRecursiveDepthnocacheofflineonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveOptions.html b/interfaces/_helia_ipns.index.ResolveOptions.html index 205ad14b..cd7e09f5 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? offline? onProgress? signal?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional nocache

                                                                                                                                                                                                                                                          nocache?: boolean

                                                                                                                                                                                                                                                          Do not use cached IPNS Record entries

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Optional offline

                                                                                                                                                                                                                                                          offline?: boolean

                                                                                                                                                                                                                                                          Do not query the network for the IPNS record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          nocacheofflineonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          nocacheofflineonProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.index.ResolveResult.html b/interfaces/_helia_ipns.index.ResolveResult.html index a8af63de..4c183738 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

                                                                                                                                                                                                                                                          cid path

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          cid

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

                                                                                                                                                                                                                                                          The CID that was resolved

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          path

                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          path

                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          Any path component that was part of the resolved record

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          ""
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          cidpath
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          cidpath
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.GetOptions.html b/interfaces/_helia_ipns.routing.GetOptions.html index c083a547..d4e00f0a 100644 --- a/interfaces/_helia_ipns.routing.GetOptions.html +++ b/interfaces/_helia_ipns.routing.GetOptions.html @@ -1,7 +1,7 @@ -GetOptions | Helia

                                                                                                                                                                                                                                                          Interface GetOptions

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

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? +GetOptions | Helia

                                                                                                                                                                                                                                                          Interface GetOptions

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

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? signal? validate?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            • (evt): void

                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                              • evt: any

                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Optional validate

                                                                                                                                                                                                                                                          validate?: boolean

                                                                                                                                                                                                                                                          Pass false to not perform validation actions

                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          onProgresssignalvalidate
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          onProgresssignalvalidate
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.IPNSRouting.html b/interfaces/_helia_ipns.routing.IPNSRouting.html index 292d13f3..208c081f 100644 --- a/interfaces/_helia_ipns.routing.IPNSRouting.html +++ b/interfaces/_helia_ipns.routing.IPNSRouting.html @@ -1,3 +1,3 @@ -IPNSRouting | Helia

                                                                                                                                                                                                                                                          Interface IPNSRouting

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

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          get +IPNSRouting | Helia

                                                                                                                                                                                                                                                          Interface IPNSRouting

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

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          get put -

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          get

                                                                                                                                                                                                                                                          put

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          getput
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          get

                                                                                                                                                                                                                                                          put

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          getput
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_ipns.routing.PutOptions.html b/interfaces/_helia_ipns.routing.PutOptions.html index 15d1f1a5..099323d7 100644 --- a/interfaces/_helia_ipns.routing.PutOptions.html +++ b/interfaces/_helia_ipns.routing.PutOptions.html @@ -1,3 +1,3 @@ -PutOptions | Helia

                                                                                                                                                                                                                                                          Interface PutOptions

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

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? +PutOptions | Helia

                                                                                                                                                                                                                                                          Interface PutOptions

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

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          onProgress? signal?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            • (evt): void

                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                              • evt: any

                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          onProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.AddOptions.html b/interfaces/_helia_json.AddOptions.html index 2d753fde..a53b8486 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 onProgress? signal? -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          hasher

                                                                                                                                                                                                                                                          hasher: MultihashHasher<number>

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          hasheronProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          hasher

                                                                                                                                                                                                                                                          hasher: MultihashHasher<number>

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          hasheronProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.GetOptions.html b/interfaces/_helia_json.GetOptions.html index 019df5ea..a2b520e9 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 onProgress? signal? -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codec

                                                                                                                                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          codeconProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codec

                                                                                                                                                                                                                                                          codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                          Optional onProgress

                                                                                                                                                                                                                                                          onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                          Optional signal

                                                                                                                                                                                                                                                          signal?: AbortSignal

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          codeconProgresssignal
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.JSON.html b/interfaces/_helia_json.JSON.html index 9d9c5bbf..28bbb0df 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

                                                                                                                                                                                                                                                          add get

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          add

                                                                                                                                                                                                                                                          • add(str, options?): Promise<CID<unknown, number, number, Version>>

                                                                                                                                                                                                                                                          • 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

                                                                                                                                                                                                                                                          get

                                                                                                                                                                                                                                                          • get<T>(cid, options?): Promise<T>

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

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          addget
                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          addget
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_json.JSONComponents.html b/interfaces/_helia_json.JSONComponents.html index bfca267b..a5eec335 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

                                                                                                                                                                                                                                                          blockstore -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          blockstore

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

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          blockstore
                                                                                                                                                                                                                                                                          \ No newline at end of file +JSONComponents | Helia

                                                                                                                                                                                                                                                                          Interface JSONComponents

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

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          blockstore +

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          blockstore

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

                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          blockstore
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFS.html b/interfaces/_helia_mfs.MFS.html index 9850ea1c..4e5dcecb 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

                                                                                                                                                                                                                                                                                          cat

                                                                                                                                                                                                                                                                                          chmod

                                                                                                                                                                                                                                                                                          chmod

                                                                                                                                                                                                                                                                                          • chmod(path, mode, options?): Promise<void>

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

                                                                                                                                                                                                                                                                                          cp

                                                                                                                                                                                                                                                                                          cp

                                                                                                                                                                                                                                                                                          • cp(source, destination, options?): Promise<void>

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

                                                                                                                                                                                                                                                                                          ls

                                                                                                                                                                                                                                                                                          ls

                                                                                                                                                                                                                                                                                          mkdir

                                                                                                                                                                                                                                                                                          mkdir

                                                                                                                                                                                                                                                                                          rm

                                                                                                                                                                                                                                                                                          rm

                                                                                                                                                                                                                                                                                          stat

                                                                                                                                                                                                                                                                                          stat

                                                                                                                                                                                                                                                                                          touch

                                                                                                                                                                                                                                                                                          touch

                                                                                                                                                                                                                                                                                          • touch(path, options?): Promise<void>

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

                                                                                                                                                                                                                                                                                          writeByteStream

                                                                                                                                                                                                                                                                                          writeByteStream

                                                                                                                                                                                                                                                                                          • writeByteStream(bytes, path, options?): Promise<void>

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

                                                                                                                                                                                                                                                                                          writeBytes

                                                                                                                                                                                                                                                                                          writeBytes

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          catchmodcplsmkdirrmstattouchwriteByteStreamwriteBytes
                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          catchmodcplsmkdirrmstattouchwriteByteStreamwriteBytes
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFSComponents.html b/interfaces/_helia_mfs.MFSComponents.html index 8f450b72..bf15a23f 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

                                                                                                                                                                                                                                                                                          blockstore datastore -

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          blockstore

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

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                          datastore

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

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              blockstoredatastore
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              blockstore

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

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                              datastore

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

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  blockstoredatastore
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_mfs.MFSInit.html b/interfaces/_helia_mfs.MFSInit.html index f702a576..19cba752 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

                                                                                                                                                                                                                                                                                                                                                                  key?

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  Optional key

                                                                                                                                                                                                                                                                                                                                                                  key?: string

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

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  key
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  key
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_mfs.RmOptions.html b/interfaces/_helia_mfs.RmOptions.html index 7f94fcf8..ff2e2f3c 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

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

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (view full)

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  force offline? onProgress? shardSplitThresholdBytes signal?

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  force

                                                                                                                                                                                                                                                                                                                                                                  force: boolean

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

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                  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 554139be..c3a8396a 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 hasher onProgress? signal? -

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                                                                                                                                  hasher

                                                                                                                                                                                                                                                                                                                                                                  hasher: MultihashHasher<number>

                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  codechasheronProgresssignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                                                                                                                                  hasher

                                                                                                                                                                                                                                                                                                                                                                  hasher: MultihashHasher<number>

                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  codechasheronProgresssignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.GetOptions.html b/interfaces/_helia_strings.GetOptions.html index bc8f24fa..1523c8e1 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 onProgress? signal? -

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  codeconProgresssignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  codec

                                                                                                                                                                                                                                                                                                                                                                  codec: BlockCodec<any, unknown>

                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  codeconProgresssignal
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.Strings.html b/interfaces/_helia_strings.Strings.html index 6a88cf93..869b66e9 100644 --- a/interfaces/_helia_strings.Strings.html +++ b/interfaces/_helia_strings.Strings.html @@ -1,13 +1,13 @@ Strings | Helia

                                                                                                                                                                                                                                                                                                                                                                  Interface Strings

                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                  add get

                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                  add

                                                                                                                                                                                                                                                                                                                                                                  • add(str, options?): Promise<CID<unknown, number, number, Version>>

                                                                                                                                                                                                                                                                                                                                                                  • 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

                                                                                                                                                                                                                                                                                                                                                                  get

                                                                                                                                                                                                                                                                                                                                                                  • get(cid, options?): Promise<string>

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

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  addget
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  addget
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_strings.StringsComponents.html b/interfaces/_helia_strings.StringsComponents.html index 066a444d..7590cf99 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

                                                                                                                                                                                                                                                                                                                                                                  blockstore -

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  blockstore

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

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  blockstore
                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +StringsComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                                  Interface StringsComponents

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

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  blockstore +

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  blockstore

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

                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.AddOptions.html b/interfaces/_helia_unixfs.index.AddOptions.html index 3850d90d..0de8abc8 100644 --- a/interfaces/_helia_unixfs.index.AddOptions.html +++ b/interfaces/_helia_unixfs.index.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface AddOptions

                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  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 bbc70226..577ef69e 100644 --- a/interfaces/_helia_unixfs.index.CatOptions.html +++ b/interfaces/_helia_unixfs.index.CatOptions.html @@ -1,13 +1,13 @@ CatOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface CatOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the cat command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  length? offline? offset? onProgress? path? signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional length

                                                                                                                                                                                                                                                                                                                                                                                                  length?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Stop reading the file after this many bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offset

                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the file at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow reading files inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  lengthofflineoffsetonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offset

                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the file at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow reading files inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  lengthofflineoffsetonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.ChmodOptions.html b/interfaces/_helia_unixfs.index.ChmodOptions.html index ec4dd099..7cf6f919 100644 --- a/interfaces/_helia_unixfs.index.ChmodOptions.html +++ b/interfaces/_helia_unixfs.index.ChmodOptions.html @@ -1,5 +1,5 @@ ChmodOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface ChmodOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the chmod command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline? onProgress? path? recursive @@ -7,9 +7,9 @@ signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set the mode on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  recursive

                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set the mode on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  recursive

                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgresspathrecursiveshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgresspathrecursiveshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.CpOptions.html b/interfaces/_helia_unixfs.index.CpOptions.html index 466b3ee2..ad4525c8 100644 --- a/interfaces/_helia_unixfs.index.CpOptions.html +++ b/interfaces/_helia_unixfs.index.CpOptions.html @@ -1,12 +1,12 @@ CpOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface CpOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the cp command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  force offline? onProgress? shardSplitThresholdBytes signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  force

                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  forceofflineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  forceofflineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.LsOptions.html b/interfaces/_helia_unixfs.index.LsOptions.html index 7a1ac5ec..d8b0daab 100644 --- a/interfaces/_helia_unixfs.index.LsOptions.html +++ b/interfaces/_helia_unixfs.index.LsOptions.html @@ -1,14 +1,14 @@ LsOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface LsOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the ls command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  length? offline? offset? onProgress? path? signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional length

                                                                                                                                                                                                                                                                                                                                                                                                  length?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Stop reading the directory contents after this many directory entries

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offset

                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the directory entries at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offset

                                                                                                                                                                                                                                                                                                                                                                                                  offset?: number

                                                                                                                                                                                                                                                                                                                                                                                                  Start reading the directory entries at this offset

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  lengthofflineoffsetonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  lengthofflineoffsetonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.MkdirOptions.html b/interfaces/_helia_unixfs.index.MkdirOptions.html index 0213c6d4..70ba80a8 100644 --- a/interfaces/_helia_unixfs.index.MkdirOptions.html +++ b/interfaces/_helia_unixfs.index.MkdirOptions.html @@ -1,5 +1,5 @@ MkdirOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface MkdirOptions

                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersion +
                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersion: Version

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  force

                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mode

                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mode to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mtime to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  force

                                                                                                                                                                                                                                                                                                                                                                                                  force: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mode

                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mode to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  An optional mtime to set on the new directory

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersionforcemodemtimeofflineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  cidVersionforcemodemtimeofflineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.RmOptions.html b/interfaces/_helia_unixfs.index.RmOptions.html index 6f4d0faa..9b4c9a5c 100644 --- a/interfaces/_helia_unixfs.index.RmOptions.html +++ b/interfaces/_helia_unixfs.index.RmOptions.html @@ -1,10 +1,10 @@ RmOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface RmOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the rm command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline? onProgress? shardSplitThresholdBytes signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgressshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.StatOptions.html b/interfaces/_helia_unixfs.index.StatOptions.html index 7cd01db2..bab81733 100644 --- a/interfaces/_helia_unixfs.index.StatOptions.html +++ b/interfaces/_helia_unixfs.index.StatOptions.html @@ -1,9 +1,9 @@ StatOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface StatOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Options to pass to the stat command

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  offline? onProgress? path? signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow statting paths inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    • (evt): void

                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional path to allow statting paths inside directories

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  offlineonProgresspathsignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.TouchOptions.html b/interfaces/_helia_unixfs.index.TouchOptions.html index 512bfab2..1f67f8c3 100644 --- a/interfaces/_helia_unixfs.index.TouchOptions.html +++ b/interfaces/_helia_unixfs.index.TouchOptions.html @@ -1,5 +1,5 @@ TouchOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface TouchOptions

                                                                                                                                                                                                                                                                                                                                                                                                  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

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

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  mtime? offline? onProgress? path? @@ -7,10 +7,10 @@ shardSplitThresholdBytes signal?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional offline

                                                                                                                                                                                                                                                                                                                                                                                                  offline?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set mtime on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  recursive

                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path

                                                                                                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional path to set mtime on directory contents

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  recursive

                                                                                                                                                                                                                                                                                                                                                                                                  recursive: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes

                                                                                                                                                                                                                                                                                                                                                                                                  shardSplitThresholdBytes: number

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  mtimeofflineonProgresspathrecursiveshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  mtimeofflineonProgresspathrecursiveshardSplitThresholdBytessignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFS.html b/interfaces/_helia_unixfs.index.UnixFS.html index b15463e6..02dc16ad 100644 --- a/interfaces/_helia_unixfs.index.UnixFS.html +++ b/interfaces/_helia_unixfs.index.UnixFS.html @@ -1,6 +1,6 @@ UnixFS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnixFS

                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  addAll +
                                                                                                                                                                                                                                                                                                                                                                                                  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)
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  addByteStream

                                                                                                                                                                                                                                                                                                                                                                                                  addByteStream

                                                                                                                                                                                                                                                                                                                                                                                                  addBytes

                                                                                                                                                                                                                                                                                                                                                                                                  addBytes

                                                                                                                                                                                                                                                                                                                                                                                                  addDirectory

                                                                                                                                                                                                                                                                                                                                                                                                  addDirectory

                                                                                                                                                                                                                                                                                                                                                                                                  addFile

                                                                                                                                                                                                                                                                                                                                                                                                  addFile

                                                                                                                                                                                                                                                                                                                                                                                                  cat

                                                                                                                                                                                                                                                                                                                                                                                                  cat

                                                                                                                                                                                                                                                                                                                                                                                                  chmod

                                                                                                                                                                                                                                                                                                                                                                                                  chmod

                                                                                                                                                                                                                                                                                                                                                                                                  • chmod(cid, mode, options?): Promise<CID<unknown, number, number, Version>>

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

                                                                                                                                                                                                                                                                                                                                                                                                  cp

                                                                                                                                                                                                                                                                                                                                                                                                  cp

                                                                                                                                                                                                                                                                                                                                                                                                  • cp(source, target, name, options?): Promise<CID<unknown, number, number, Version>>

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

                                                                                                                                                                                                                                                                                                                                                                                                  ls

                                                                                                                                                                                                                                                                                                                                                                                                  ls

                                                                                                                                                                                                                                                                                                                                                                                                  mkdir

                                                                                                                                                                                                                                                                                                                                                                                                  mkdir

                                                                                                                                                                                                                                                                                                                                                                                                  rm

                                                                                                                                                                                                                                                                                                                                                                                                  rm

                                                                                                                                                                                                                                                                                                                                                                                                  • rm(cid, path, options?): Promise<CID<unknown, number, number, Version>>

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

                                                                                                                                                                                                                                                                                                                                                                                                  stat

                                                                                                                                                                                                                                                                                                                                                                                                  stat

                                                                                                                                                                                                                                                                                                                                                                                                  touch

                                                                                                                                                                                                                                                                                                                                                                                                  touch

                                                                                                                                                                                                                                                                                                                                                                                                  • touch(cid, options?): Promise<CID<unknown, number, number, Version>>

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

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  addAlladdByteStreamaddBytesaddDirectoryaddFilecatchmodcplsmkdirrmstattouch
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  addAlladdByteStreamaddBytesaddDirectoryaddFilecatchmodcplsmkdirrmstattouch
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFSComponents.html b/interfaces/_helia_unixfs.index.UnixFSComponents.html index 8852d5e3..1b282d73 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

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore -

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore

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

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +UnixFSComponents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnixFSComponents

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

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore +

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore

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

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  blockstore
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_unixfs.index.UnixFSStats.html b/interfaces/_helia_unixfs.index.UnixFSStats.html index b26b8203..722e7fc9 100644 --- a/interfaces/_helia_unixfs.index.UnixFSStats.html +++ b/interfaces/_helia_unixfs.index.UnixFSStats.html @@ -1,5 +1,5 @@ UnixFSStats | Helia

                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnixFSStats

                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  blocks +
                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                  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: CID<unknown, number, number, Version>

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory CID

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  dagSize

                                                                                                                                                                                                                                                                                                                                                                                                  dagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the DAG that holds the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  fileSize

                                                                                                                                                                                                                                                                                                                                                                                                  fileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize

                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize: bigint

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize

                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the file is in the local block store

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mode

                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mode

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mtime

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  type

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

                                                                                                                                                                                                                                                                                                                                                                                                  The type of file

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Optional unixfs

                                                                                                                                                                                                                                                                                                                                                                                                  unixfs?: UnixFS

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

                                                                                                                                                                                                                                                                                                                                                                                                  cid

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

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory CID

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  dagSize

                                                                                                                                                                                                                                                                                                                                                                                                  dagSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the DAG that holds the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  fileSize

                                                                                                                                                                                                                                                                                                                                                                                                  fileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  The size of the file in bytes

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize

                                                                                                                                                                                                                                                                                                                                                                                                  localDagSize: bigint

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

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize

                                                                                                                                                                                                                                                                                                                                                                                                  localFileSize: bigint

                                                                                                                                                                                                                                                                                                                                                                                                  How much of the file is in the local block store

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mode

                                                                                                                                                                                                                                                                                                                                                                                                  mode?: number

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mode

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional mtime

                                                                                                                                                                                                                                                                                                                                                                                                  mtime?: Mtime

                                                                                                                                                                                                                                                                                                                                                                                                  The file or directory mtime

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  type

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

                                                                                                                                                                                                                                                                                                                                                                                                  The type of file

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Optional unixfs

                                                                                                                                                                                                                                                                                                                                                                                                  unixfs?: UnixFS

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

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  blocksciddagSizefileSizelocalDagSizelocalFileSizemodemtimetypeunixfs
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  blocksciddagSizefileSizelocalDagSizelocalFileSizemodemtimetypeunixfs
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_utils.AbstractCreateSessionOptions.html b/interfaces/_helia_utils.AbstractCreateSessionOptions.html index 1c39f6a8..41f74a8e 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

                                                                                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  maxProvidersminProvidersnameonProgresssignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                  name

                                                                                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                                                                                  Optional onProgress

                                                                                                                                                                                                                                                                                                                                                                                                  onProgress?: ((evt) => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Optional signal

                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  maxProvidersminProvidersnameonProgresssignal
                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/_helia_utils.HeliaInit.html b/interfaces/_helia_utils.HeliaInit.html index 638bad69..4274024e 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

                                                                                                                                                                                                                                                                                                                                                                                                    blockBrokers +
                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                      blockBrokers blockstore components? dagWalkers? @@ -13,17 +13,17 @@ routers?

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      blockBrokers

                                                                                                                                                                                                                                                                                                                                                                                                      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: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                      The blockstore is where blocks are stored

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      Optional components

                                                                                                                                                                                                                                                                                                                                                                                                                      components?: Record<string, any>

                                                                                                                                                                                                                                                                                                                                                                                                                      Components used by subclasses

                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                      Optional dagWalkers

                                                                                                                                                                                                                                                                                                                                                                                                                      dagWalkers?: DAGWalker[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      blockstore

                                                                                                                                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional components

                                                                                                                                                                                                                                                                                                                                                                                                                                      components?: Record<string, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Components used by subclasses

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional dagWalkers

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional dns

                                                                                                                                                                                                                                                                                                                                                                                                                                                          dns?: DNS

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional hashers

                                                                                                                                                                                                                                                                                                                                                                                                                                                          hashers?: MultihashHasher<number>[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                          datastore

                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional dns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dns?: DNS

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional hashers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional holdGcLock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              holdGcLock?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Garbage collection requires preventing blockstore writes during searches +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional holdGcLock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger?: ComponentLogger

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger?: ComponentLogger

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional providerLookupConcurrency

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              providerLookupConcurrency?: number

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional providerLookupConcurrency

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional routers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Routers perform operations such as looking up content providers, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional routers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockloggermetricsproviderLookupConcurrencyrouters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockloggermetricsproviderLookupConcurrencyrouters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.DAGWalker.html b/interfaces/helia.DAGWalker.html index aea6d01f..0074722b 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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              walk -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              walk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codecwalk
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codec: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              walk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              codecwalk
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.DefaultLibp2pServices.html b/interfaces/helia.DefaultLibp2pServices.html index 6009e5f6..292a52b1 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT dcutr delegatedRouting dht @@ -7,4 +7,4 @@ ping relay upnp -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht: KadDHT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify: Identify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain: Keychain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ping: PingService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              relay

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              relay: CircuitRelayService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNATdcutrdelegatedRoutingdhtidentifykeychainpingrelayupnp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNAT: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dcutr: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delegatedRouting: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dht: KadDHT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify: Identify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keychain: Keychain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ping: PingService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              relay

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              relay: CircuitRelayService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              upnp: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoNATdcutrdelegatedRoutingdhtidentifykeychainpingrelayupnp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.HeliaInit.html b/interfaces/helia.HeliaInit.html index 46338479..89566a4b 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokers +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokers blockstore components? dagWalkers? @@ -38,7 +38,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional keychain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional libp2p

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional libp2p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger?: ComponentLogger

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger?: ComponentLogger

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -63,4 +63,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional routers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routers?: Partial<Routing>[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Pass false to not start the Helia node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockkeychainlibp2ploggermetricsproviderLookupConcurrencyroutersstart
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockBrokersblockstorecomponentsdagWalkersdatastorednshashersholdGcLockkeychainlibp2ploggermetricsproviderLookupConcurrencyroutersstart
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/interfaces/helia.HeliaLibp2p.html b/interfaces/helia.HeliaLibp2p.html index d62d00f5..dfc856d3 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockstore +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hashers: Record<number, MultihashHasher<number>>

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A logging component that can be reused by consumers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              libp2p: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger: ComponentLogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A logging component that can be reused by consumers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional metrics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              metrics?: Metrics

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pins: Pins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Pinning operations for blocks in the blockstore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/modules/_helia_interface.blocks.html b/modules/_helia_interface.blocks.html index 63e0ee27..4062888f 100644 --- a/modules/_helia_interface.blocks.html +++ b/modules/_helia_interface.blocks.html @@ -1,4 +1,4 @@ -blocks | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module blocks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BlockAnnounceOptions +blocks | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module blocks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module pins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions +pins | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module pins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions IsPinnedOptions LsOptions Pin diff --git a/modules/_helia_ipns.index.html b/modules/_helia_ipns.index.html index 9c47ad78..ef63e3ed 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRouting +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRouting IPNSRoutingEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module routing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetOptions +routing | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module routing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetOptions IPNSRouting PutOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRoutingEvents diff --git a/modules/_helia_unixfs.errors.html b/modules/_helia_unixfs.errors.html index 8e932bdc..001088b2 100644 --- a/modules/_helia_unixfs.errors.html +++ b/modules/_helia_unixfs.errors.html @@ -1,4 +1,4 @@ -errors | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AlreadyExistsError +errors | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AlreadyExistsError DoesNotExistError InvalidPBNodeError InvalidParametersError diff --git a/modules/_helia_unixfs.index.html b/modules/_helia_unixfs.index.html index d2ea67ee..ddeff571 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddOptions +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interfaces

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapNotifyProgressEvents: BitswapNetworkNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +BitswapNotifyProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapNotifyProgressEvents: BitswapNetworkNotifyProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_bitswap.BitswapWantBlockProgressEvents.html b/types/_helia_bitswap.BitswapWantBlockProgressEvents.html index f3472dfd..729b96eb 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_bitswap.BitswapWantProgressEvents.html b/types/_helia_bitswap.BitswapWantProgressEvents.html index 259f5dcd..94f85443 100644 --- a/types/_helia_bitswap.BitswapWantProgressEvents.html +++ b/types/_helia_bitswap.BitswapWantProgressEvents.html @@ -1 +1 @@ -BitswapWantProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantProgressEvents: BitswapWantBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +BitswapWantProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias BitswapWantProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BitswapWantProgressEvents: BitswapWantBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.DeleteBlockProgressEvents.html b/types/_helia_interface.blocks.DeleteBlockProgressEvents.html index 2ab832b7..a3e349c5 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DeleteBlockProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteBlockProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteBlockProgressEvents: ProgressEvent<"blocks:delete:blockstore:delete", CID>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html b/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html index 10069a82..000d744c 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">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DeleteManyBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias DeleteManyBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DeleteManyBlocksProgressEvents: ProgressEvent<"blocks:delete-many:blockstore:delete-many">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html b/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html index bfe92cd1..468b6d21 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">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetAllBlocksProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetAllBlocksProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetAllBlocksProgressEvents: ProgressEvent<"blocks:get-all:blockstore:get-many">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetBlockProgressEvents.html b/types/_helia_interface.blocks.GetBlockProgressEvents.html index fa44bb8c..64f0b748 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html b/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html index 232a65d5..95c2e18f 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.HasBlockProgressEvents.html b/types/_helia_interface.blocks.HasBlockProgressEvents.html index f2f8b54d..bf1331b5 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.PutBlockProgressEvents.html b/types/_helia_interface.blocks.PutBlockProgressEvents.html index a4d96461..9c053650 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html b/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html index 24ff4530..d6dc38e7 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">

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.index.GcEvents.html b/types/_helia_interface.index.GcEvents.html index 28c2310a..5aabba8c 100644 --- a/types/_helia_interface.index.GcEvents.html +++ b/types/_helia_interface.index.GcEvents.html @@ -1 +1 @@ -GcEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GcEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GcEvents: ProgressEvent<"helia:gc:deleted", CID> | ProgressEvent<"helia:gc:error", Error>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GcEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GcEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GcEvents: ProgressEvent<"helia:gc:deleted", CID> | ProgressEvent<"helia:gc:error", Error>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.pins.AddPinEvents.html b/types/_helia_interface.pins.AddPinEvents.html index 3c672c22..b3c4a424 100644 --- a/types/_helia_interface.pins.AddPinEvents.html +++ b/types/_helia_interface.pins.AddPinEvents.html @@ -1 +1 @@ -AddPinEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias AddPinEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddPinEvents: ProgressEvent<"helia:pin:add", CID>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +AddPinEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias AddPinEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddPinEvents: ProgressEvent<"helia:pin:add", CID>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_interface.pins.PinType.html b/types/_helia_interface.pins.PinType.html index cec0839c..74ffa599 100644 --- a/types/_helia_interface.pins.PinType.html +++ b/types/_helia_interface.pins.PinType.html @@ -1 +1 @@ -PinType | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PinType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PinType: "recursive" | "direct" | "indirect"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +PinType | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias PinType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PinType: "recursive" | "direct" | "indirect"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.PublishProgressEvents.html b/types/_helia_ipns.index.PublishProgressEvents.html index 4b610d55..49d3d8b5 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.RepublishProgressEvents.html b/types/_helia_ipns.index.RepublishProgressEvents.html index 282f3c54..f810e1ec 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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ 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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html b/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html index a4ecf91d..1278434e 100644 --- a/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html +++ b/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html @@ -1 +1 @@ -ResolveDNSLinkProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias ResolveDNSLinkProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ResolveDNSLinkProgressEvents: ResolveProgressEvents | IPNSRoutingEvents | ResolveDnsProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +ResolveDNSLinkProgressEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias ResolveDNSLinkProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ResolveDNSLinkProgressEvents: ResolveProgressEvents | IPNSRoutingEvents | ResolveDnsProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.index.ResolveProgressEvents.html b/types/_helia_ipns.index.ResolveProgressEvents.html index 6e382ca1..0145e920 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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_ipns.routing.IPNSRoutingEvents.html b/types/_helia_ipns.routing.IPNSRoutingEvents.html index a48ffb98..6f67bf04 100644 --- a/types/_helia_ipns.routing.IPNSRoutingEvents.html +++ b/types/_helia_ipns.routing.IPNSRoutingEvents.html @@ -1 +1 @@ -IPNSRoutingEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias IPNSRoutingEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRoutingEvents: DatastoreProgressEvents | HeliaRoutingProgressEvents | PubSubProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +IPNSRoutingEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias IPNSRoutingEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPNSRoutingEvents: DatastoreProgressEvents | HeliaRoutingProgressEvents | PubSubProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_mfs.MkdirOptions.html b/types/_helia_mfs.MkdirOptions.html index 85c501ce..9da0d10d 100644 --- a/types/_helia_mfs.MkdirOptions.html +++ b/types/_helia_mfs.MkdirOptions.html @@ -1 +1 @@ -MkdirOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias MkdirOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              MkdirOptions: AddOptions & StatOptions & CpOptions & MkdirOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +MkdirOptions | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias MkdirOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              MkdirOptions: AddOptions & StatOptions & CpOptions & MkdirOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_mfs.WriteOptions.html b/types/_helia_mfs.WriteOptions.html index 413a26aa..9863383d 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_unixfs.index.AddEvents.html b/types/_helia_unixfs.index.AddEvents.html index b8a2a2a9..5eb23463 100644 --- a/types/_helia_unixfs.index.AddEvents.html +++ b/types/_helia_unixfs.index.AddEvents.html @@ -1 +1 @@ -AddEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias AddEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddEvents: PutBlockProgressEvents | ImporterProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +AddEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias AddEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AddEvents: PutBlockProgressEvents | ImporterProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/types/_helia_unixfs.index.GetEvents.html b/types/_helia_unixfs.index.GetEvents.html index 29b10a79..c440a905 100644 --- a/types/_helia_unixfs.index.GetEvents.html +++ b/types/_helia_unixfs.index.GetEvents.html @@ -1 +1 @@ -GetEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetEvents: GetBlockProgressEvents | ExporterProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +GetEvents | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type alias GetEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GetEvents: GetBlockProgressEvents | ExporterProgressEvents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ 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 bbaed8b2..a7e58545 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DEFAULT_SESSION_MAX_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MAX_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MAX_PROVIDERS: 5 = 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ 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 083a4f83..c94de94a 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +DEFAULT_SESSION_MIN_PROVIDERS | Helia

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable DEFAULT_SESSION_MIN_PROVIDERSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_SESSION_MIN_PROVIDERS: 1 = 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file