From 0509fa1b30df8cdcedddd5b92e00c6516ae86c9f Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Mon, 8 Jan 2024 13:54:56 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- classes/errors.AlreadyExistsError.html | 4 ++-- classes/errors.DoesNotExistError.html | 4 ++-- classes/errors.InvalidPBNodeError.html | 4 ++-- classes/errors.InvalidParametersError.html | 4 ++-- classes/errors.NoContentError.html | 4 ++-- classes/errors.NotADirectoryError.html | 4 ++-- classes/errors.NotAFileError.html | 4 ++-- classes/errors.NotUnixFSError.html | 4 ++-- classes/errors.UnixFSError.html | 4 ++-- classes/errors.UnknownError.html | 4 ++-- functions/index.globSource.html | 2 +- functions/index.unixfs-1.html | 2 +- functions/index.urlSource.html | 2 +- index.html | 4 ++-- interfaces/index.AddOptions.html | 2 +- interfaces/index.CatOptions.html | 10 ++++---- interfaces/index.ChmodOptions.html | 10 ++++---- interfaces/index.CpOptions.html | 8 +++---- interfaces/index.LsOptions.html | 10 ++++---- interfaces/index.MkdirOptions.html | 14 +++++------ interfaces/index.RmOptions.html | 6 ++--- interfaces/index.StatOptions.html | 6 ++--- interfaces/index.TouchOptions.html | 12 +++++----- interfaces/index.UnixFS.html | 28 +++++++++++----------- interfaces/index.UnixFSComponents.html | 4 ++-- interfaces/index.UnixFSStats.html | 22 ++++++++--------- modules/errors.html | 2 +- modules/index.html | 2 +- types/index.AddEvents.html | 2 +- types/index.GetEvents.html | 2 +- 30 files changed, 95 insertions(+), 95 deletions(-) diff --git a/classes/errors.AlreadyExistsError.html b/classes/errors.AlreadyExistsError.html index ff1bf88..c24412b 100644 --- a/classes/errors.AlreadyExistsError.html +++ b/classes/errors.AlreadyExistsError.html @@ -1,4 +1,4 @@ -AlreadyExistsError | @helia/unixfs

Class AlreadyExistsError

Hierarchy (view full)

Constructors

constructor +AlreadyExistsError | @helia/unixfs

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

See

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

diff --git a/classes/errors.DoesNotExistError.html b/classes/errors.DoesNotExistError.html index 1f44d64..b2296d3 100644 --- a/classes/errors.DoesNotExistError.html +++ b/classes/errors.DoesNotExistError.html @@ -1,4 +1,4 @@ -DoesNotExistError | @helia/unixfs

Class DoesNotExistError

Hierarchy (view full)

Constructors

constructor +DoesNotExistError | @helia/unixfs

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

See

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

diff --git a/classes/errors.InvalidPBNodeError.html b/classes/errors.InvalidPBNodeError.html index 9a6d515..b704942 100644 --- a/classes/errors.InvalidPBNodeError.html +++ b/classes/errors.InvalidPBNodeError.html @@ -1,4 +1,4 @@ -InvalidPBNodeError | @helia/unixfs

Class InvalidPBNodeError

Hierarchy (view full)

Constructors

constructor +InvalidPBNodeError | @helia/unixfs

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

See

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

diff --git a/classes/errors.InvalidParametersError.html b/classes/errors.InvalidParametersError.html index fafffdc..ebd09c8 100644 --- a/classes/errors.InvalidParametersError.html +++ b/classes/errors.InvalidParametersError.html @@ -1,4 +1,4 @@ -InvalidParametersError | @helia/unixfs

Class InvalidParametersError

Hierarchy (view full)

Constructors

constructor +InvalidParametersError | @helia/unixfs

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

See

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

diff --git a/classes/errors.NoContentError.html b/classes/errors.NoContentError.html index d5d87dd..56d6782 100644 --- a/classes/errors.NoContentError.html +++ b/classes/errors.NoContentError.html @@ -1,4 +1,4 @@ -NoContentError | @helia/unixfs

Class NoContentError

Hierarchy (view full)

Constructors

constructor +NoContentError | @helia/unixfs

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

See

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

diff --git a/classes/errors.NotADirectoryError.html b/classes/errors.NotADirectoryError.html index 5c22c33..ab9eb18 100644 --- a/classes/errors.NotADirectoryError.html +++ b/classes/errors.NotADirectoryError.html @@ -1,4 +1,4 @@ -NotADirectoryError | @helia/unixfs

Class NotADirectoryError

Hierarchy (view full)

Constructors

constructor +NotADirectoryError | @helia/unixfs

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

See

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

diff --git a/classes/errors.NotAFileError.html b/classes/errors.NotAFileError.html index bd78cf5..b6beac5 100644 --- a/classes/errors.NotAFileError.html +++ b/classes/errors.NotAFileError.html @@ -1,4 +1,4 @@ -NotAFileError | @helia/unixfs

Class NotAFileError

Hierarchy (view full)

Constructors

constructor +NotAFileError | @helia/unixfs

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

See

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

diff --git a/classes/errors.NotUnixFSError.html b/classes/errors.NotUnixFSError.html index 3170bd9..0b68e32 100644 --- a/classes/errors.NotUnixFSError.html +++ b/classes/errors.NotUnixFSError.html @@ -1,4 +1,4 @@ -NotUnixFSError | @helia/unixfs

Class NotUnixFSError

Hierarchy (view full)

Constructors

constructor +NotUnixFSError | @helia/unixfs

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

See

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

diff --git a/classes/errors.UnixFSError.html b/classes/errors.UnixFSError.html index 0435807..de4df39 100644 --- a/classes/errors.UnixFSError.html +++ b/classes/errors.UnixFSError.html @@ -1,4 +1,4 @@ -UnixFSError | @helia/unixfs

Class UnixFSErrorAbstract

Hierarchy (view full)

Constructors

constructor +UnixFSError | @helia/unixfs

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

See

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

diff --git a/classes/errors.UnknownError.html b/classes/errors.UnknownError.html index 8d244ed..8c33d9b 100644 --- a/classes/errors.UnknownError.html +++ b/classes/errors.UnknownError.html @@ -1,4 +1,4 @@ -UnknownError | @helia/unixfs

Class UnknownError

Hierarchy (view full)

Constructors

constructor +UnknownError | @helia/unixfs

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

See

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

diff --git a/functions/index.globSource.html b/functions/index.globSource.html index 6915bea..865914b 100644 --- a/functions/index.globSource.html +++ b/functions/index.globSource.html @@ -1,2 +1,2 @@ globSource | @helia/unixfs

Function globSource

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns ImportCandidateStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.unixfs-1.html b/functions/index.unixfs-1.html index d17b90b..1528a54 100644 --- a/functions/index.unixfs-1.html +++ b/functions/index.unixfs-1.html @@ -1,2 +1,2 @@ unixfs | @helia/unixfs

Function unixfs

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns UnixFS

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/index.urlSource.html b/functions/index.urlSource.html index 43b6cae..a773a67 100644 --- a/functions/index.urlSource.html +++ b/functions/index.urlSource.html @@ -1 +1 @@ -urlSource | @helia/unixfs

Function urlSource

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +urlSource | @helia/unixfs

Function urlSource

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 756311b..ef7e0b0 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -@helia/unixfs

@helia/unixfs

+@helia/unixfs

@helia/unixfs

📁 Archived - this repo has been merged into helia

Helia logo @@ -28,4 +28,4 @@

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.AddOptions.html b/interfaces/index.AddOptions.html index cff351f..e777e78 100644 --- a/interfaces/index.AddOptions.html +++ b/interfaces/index.AddOptions.html @@ -1,4 +1,4 @@ -AddOptions | @helia/unixfs

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/unixfs

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/index.CatOptions.html b/interfaces/index.CatOptions.html index 0073ad1..5f93aa5 100644 --- a/interfaces/index.CatOptions.html +++ b/interfaces/index.CatOptions.html @@ -1,13 +1,13 @@ CatOptions | @helia/unixfs

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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.ChmodOptions.html b/interfaces/index.ChmodOptions.html index 5ef26e8..c2d9380 100644 --- a/interfaces/index.ChmodOptions.html +++ b/interfaces/index.ChmodOptions.html @@ -1,5 +1,5 @@ ChmodOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.CpOptions.html b/interfaces/index.CpOptions.html index 198299f..9cbf557 100644 --- a/interfaces/index.CpOptions.html +++ b/interfaces/index.CpOptions.html @@ -1,12 +1,12 @@ CpOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.LsOptions.html b/interfaces/index.LsOptions.html index e6d7ada..5eb02e3 100644 --- a/interfaces/index.LsOptions.html +++ b/interfaces/index.LsOptions.html @@ -1,14 +1,14 @@ LsOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.MkdirOptions.html b/interfaces/index.MkdirOptions.html index a2f673f..9ed5443 100644 --- a/interfaces/index.MkdirOptions.html +++ b/interfaces/index.MkdirOptions.html @@ -1,5 +1,5 @@ MkdirOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.RmOptions.html b/interfaces/index.RmOptions.html index ae4aadf..602ccab 100644 --- a/interfaces/index.RmOptions.html +++ b/interfaces/index.RmOptions.html @@ -1,10 +1,10 @@ RmOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.StatOptions.html b/interfaces/index.StatOptions.html index ec51ffb..61a0588 100644 --- a/interfaces/index.StatOptions.html +++ b/interfaces/index.StatOptions.html @@ -1,9 +1,9 @@ StatOptions | @helia/unixfs

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

Generated using TypeDoc

\ 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

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.TouchOptions.html b/interfaces/index.TouchOptions.html index ff59016..d0255cb 100644 --- a/interfaces/index.TouchOptions.html +++ b/interfaces/index.TouchOptions.html @@ -1,5 +1,5 @@ TouchOptions | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.UnixFS.html b/interfaces/index.UnixFS.html index b749fc8..27337e6 100644 --- a/interfaces/index.UnixFS.html +++ b/interfaces/index.UnixFS.html @@ -1,6 +1,6 @@ UnixFS | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.UnixFSComponents.html b/interfaces/index.UnixFSComponents.html index 1b30846..11edda9 100644 --- a/interfaces/index.UnixFSComponents.html +++ b/interfaces/index.UnixFSComponents.html @@ -1,2 +1,2 @@ -UnixFSComponents | @helia/unixfs

Interface UnixFSComponents

interface UnixFSComponents {
    blockstore: Blocks;
}

Properties

blockstore -

Properties

blockstore

blockstore: Blocks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +UnixFSComponents | @helia/unixfs

Interface UnixFSComponents

interface UnixFSComponents {
    blockstore: Blocks;
}

Properties

blockstore +

Properties

blockstore

blockstore: Blocks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.UnixFSStats.html b/interfaces/index.UnixFSStats.html index dd6a9a9..714448b 100644 --- a/interfaces/index.UnixFSStats.html +++ b/interfaces/index.UnixFSStats.html @@ -1,5 +1,5 @@ UnixFSStats | @helia/unixfs

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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/errors.html b/modules/errors.html index f838898..adc6cb7 100644 --- a/modules/errors.html +++ b/modules/errors.html @@ -1,4 +1,4 @@ -errors | @helia/unixfs

Module errors

Index

Classes

AlreadyExistsError +errors | @helia/unixfs

Module errors

Index

Classes

AlreadyExistsError DoesNotExistError InvalidPBNodeError InvalidParametersError diff --git a/modules/index.html b/modules/index.html index 792a667..db4f6ed 100644 --- a/modules/index.html +++ b/modules/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/index.AddEvents.html b/types/index.AddEvents.html index 24adea7..d27b1b2 100644 --- a/types/index.AddEvents.html +++ b/types/index.AddEvents.html @@ -1 +1 @@ -AddEvents | @helia/unixfs

Type alias AddEvents

AddEvents: PutBlockProgressEvents | ImporterProgressEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AddEvents | @helia/unixfs

Type alias AddEvents

AddEvents: PutBlockProgressEvents | ImporterProgressEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/index.GetEvents.html b/types/index.GetEvents.html index 652e4ff..d7ec576 100644 --- a/types/index.GetEvents.html +++ b/types/index.GetEvents.html @@ -1 +1 @@ -GetEvents | @helia/unixfs

Type alias GetEvents

GetEvents: GetBlockProgressEvents | ExporterProgressEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +GetEvents | @helia/unixfs

Type alias GetEvents

GetEvents: GetBlockProgressEvents | ExporterProgressEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file