Class FileSystem

Index

🪺 :: START HERE

`Static` create

create(opts): Promise<FileSystem>
Creates a file system with an empty public tree & an empty private tree at the root.
Parameters
- opts: FileSystemOptions
Returns Promise<FileSystem>
- Defined in packages/nest/src/class.ts:128

`Static` fromCID

fromCID(cid, opts): Promise<FileSystem>
Loads an existing file system from a CID.
Parameters
- cid: CID<unknown, number, number, Version>
- opts: FileSystemOptions
Returns Promise<FileSystem>
- Defined in packages/nest/src/class.ts:148

Mounting

createPrivateNode

createPrivateNode(node, mutationOptions?): Promise<{
 capsuleKey: Uint8Array;
 path: [Path.Private, ...string[]];
 shareId: string;
}>
Create a new private node and mount it.
Parameters
- node: {
 exchangeKeyPair: {
 privateKey: CryptoKey;
 publicKey: Uint8Array | CryptoKey;
 };
 kind?: Kind;
 path: Segments;
 }
 - exchangeKeyPair: {
 privateKey: CryptoKey;
 publicKey: Uint8Array | CryptoKey;
 }
 - privateKey: CryptoKey
 - publicKey: Uint8Array | CryptoKey
 - Optional kind?: Kind
 - path: Segments
- Optional mutationOptions: MutationOptions
Returns Promise<{
 capsuleKey: Uint8Array;
 path: [Path.Private, ...string[]];
 shareId: string;
}>
- Defined in packages/nest/src/class.ts:265
createPrivateNode(node, mutationOptions?): Promise<{
capsuleKey: Uint8Array;
path: [Path.Private, ...string[]];
}>
Parameters
- node: {
 kind?: Kind;
 path: Segments;
 }
 - Optional kind?: Kind
 - path: Segments
- Optional mutationOptions: MutationOptions
Returns Promise<{
capsuleKey: Uint8Array;
path: [Path.Private, ...string[]];
}>
- Defined in packages/nest/src/class.ts:280

mountPrivateNode

mountPrivateNode(node): Promise<void>
Mount a private node onto the file system.
Parameters
- node: {
 capsuleKey: Uint8Array;
 path: Segments;
 } | {
 exchangeKeyPair: {
 privateKey: CryptoKey;
 publicKey: Uint8Array | CryptoKey;
 };
 path: Segments;
 shareId?: string;
 }
Returns Promise<void>
- Defined in packages/nest/src/class.ts:409

mountPrivateNodes

mountPrivateNodes(nodes): Promise<void>
Mount private nodes onto the file system.

This supports two scenarios:
- Load a private node using a capsule key
- Load a private node using an exchange key pair (this is a share made to one of your own exchange keys)
Parameters
- nodes: ({
 capsuleKey: Uint8Array;
 path: Segments;
 } | {
 exchangeKeyPair: {
 privateKey: CryptoKey;
 publicKey: Uint8Array | CryptoKey;
 };
 path: Segments;
 shareId?: string;
 })[]
Returns Promise<void>
- Defined in packages/nest/src/class.ts:437

unmountPrivateNode

unmountPrivateNode(path): void
Unmount a private node from the file system.
Parameters
- path: Segments
Returns void
- Defined in packages/nest/src/class.ts:503

Querying

ls

ls: {
 (path, listOptions): Promise<DirectoryItemWithKind[]>;
 (path, listOptions): Promise<DirectoryItem[]>;
 (path): Promise<DirectoryItem[]>;
 (path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>;
} = ...

Type declaration

- (path, listOptions): Promise<DirectoryItemWithKind[]>
- Parameters
 - path: [Partition, ...string[]]
 - listOptions: {
 withItemKind: true;
 }
 - withItemKind: true
 Returns Promise<DirectoryItemWithKind[]>
- (path, listOptions): Promise<DirectoryItem[]>
- Parameters
 - path: [Partition, ...string[]]
 - listOptions: {
 withItemKind: false;
 }
 - withItemKind: false
 Returns Promise<DirectoryItem[]>
- (path): Promise<DirectoryItem[]>
- Parameters
 - path: [Partition, ...string[]]
 Returns Promise<DirectoryItem[]>
- (path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>
- Parameters
 - path: [Partition, ...string[]]
 - Optional listOptions: {
 withItemKind: boolean;
 }
 - withItemKind: boolean
 Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

capsuleCID

capsuleCID(path): Promise<undefined | CID<unknown, number, number, Version>>
Parameters
- path: [Path.Public, ...string[]]
Returns Promise<undefined | CID<unknown, number, number, Version>>
- Defined in packages/nest/src/class.ts:523

capsuleKey

capsuleKey(path): Promise<undefined | Uint8Array>
Parameters
- path: [Path.Private, ...string[]]
Returns Promise<undefined | Uint8Array>
- Defined in packages/nest/src/class.ts:531

contentCID

contentCID(path): Promise<undefined | CID<unknown, number, number, Version>>
Parameters
- path: [Path.Public, ...string[]]
Returns Promise<undefined | CID<unknown, number, number, Version>>
- Defined in packages/nest/src/class.ts:515

exists

exists(path): Promise<boolean>
Parameters
- path: [Partition, ...string[]]
Returns Promise<boolean>
- Defined in packages/nest/src/class.ts:541

listDirectory

listDirectory(path, listOptions): Promise<DirectoryItemWithKind[]>
Parameters
- path: [Partition, ...string[]]
- listOptions: {
 withItemKind: true;
 }
 - withItemKind: true
Returns Promise<DirectoryItemWithKind[]>
- Defined in packages/nest/src/class.ts:546
listDirectory(path, listOptions): Promise<DirectoryItem[]>
Parameters
- path: [Partition, ...string[]]
- listOptions: {
 withItemKind: false;
 }
 - withItemKind: false
Returns Promise<DirectoryItem[]>
- Defined in packages/nest/src/class.ts:550
listDirectory(path): Promise<DirectoryItem[]>
Parameters
- path: [Partition, ...string[]]
Returns Promise<DirectoryItem[]>
- Defined in packages/nest/src/class.ts:554
listDirectory(path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>
Parameters
- path: [Partition, ...string[]]
- Optional listOptions: {
 withItemKind: boolean;
 }
 - withItemKind: boolean
Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>
- Defined in packages/nest/src/class.ts:555

read

read<D, V>(path, dataType, options?): Promise<DataForType<D, V>>
Type Parameters
- D extends DataType
- V = unknown
Parameters
- path: [Partition, string, ...string[]] | {
 contentCID: CID<unknown, number, number, Version>;
 } | {
 capsuleCID: CID<unknown, number, number, Version>;
 } | {
 capsuleKey: Uint8Array;
 }
- dataType: D
- Optional options: {
 length?: number;
 offset?: number;
 }
 - Optional length?: number
 - Optional offset?: number
Returns Promise<DataForType<D, V>>
- Defined in packages/nest/src/class.ts:570

size

size(path): Promise<number>
Parameters
- path: [Partition, string, ...string[]]
Returns Promise<number>
- Defined in packages/nest/src/class.ts:603

Mutating

cp

cp: (<From, To>(from, to, mutationOptions?) => Promise<MutationResult<To>>) = ...

Type declaration

- <From, To>(from, to, mutationOptions?): Promise<MutationResult<To>>
- Type Parameters
 - From extends Partition
 - To extends Partition
 Parameters
 - from: [From, string, ...string[]]
 - to: [To, ...string[]]
 - Optional mutationOptions: MutationOptions
 Returns Promise<MutationResult<To>>

mkdir

mkdir: ((path, mutationOptions?) => Promise<MutationResult>) = ...

Type declaration

- (path, mutationOptions?): Promise<MutationResult>
- Type Parameters
 - P extends Partition
 Parameters
 - path: [P, string, ...string[]]
 - Optional mutationOptions: MutationOptions
 Returns Promise<MutationResult>

mv

mv: (<From, To>(from, to, mutationOptions?) => Promise<MutationResult<To>>) = ...

Type declaration

- <From, To>(from, to, mutationOptions?): Promise<MutationResult<To>>
- Type Parameters
 - From extends Partition
 - To extends Partition
 Parameters
 - from: [From, string, ...string[]]
 - to: [To, string, ...string[]] | [To, ...string[]]
 - Optional mutationOptions: MutationOptions
 Returns Promise<MutationResult<To>>

rm

rm: ((path, mutationOptions?) => Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
}>) = ...

Type declaration

- (path, mutationOptions?): Promise<"no-op" | {
 dataRoot: CID<unknown, number, number, Version>;
 }>
- Parameters
 - path: [Partition, string, ...string[]]
 - mutationOptions: MutationOptions = {}
 Returns Promise<"no-op" | {
 dataRoot: CID<unknown, number, number, Version>;
 }>

copy

copy<From, To>(from, to, mutationOptions?): Promise<MutationResult<To>>
Type Parameters
- From extends Partition
- To extends Partition
Parameters
- from: [From, string, ...string[]]
- to: [To, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult<To>>
- Defined in packages/nest/src/class.ts:611

createDirectory

createDirectory(path, mutationOptions?): Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>
Type Parameters
- P extends Partition
Parameters
- path: [P, string, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>
- Defined in packages/nest/src/class.ts:634

createFile

createFile<P, D, V>(path, dataType, data, mutationOptions?): Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>
Type Parameters
- P extends Partition
- D extends DataType
- V = unknown
Parameters
- path: [P, string, ...string[]]
- dataType: DataType
- data: DataForType<D, V>
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>
- Defined in packages/nest/src/class.ts:662

ensureDirectory

ensureDirectory(path, mutationOptions?): Promise<MutationResult>
Type Parameters
- P extends Partition
Parameters
- path: [P, string, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult>
- Defined in packages/nest/src/class.ts:694

move

move<From, To>(from, to, mutationOptions?): Promise<MutationResult<To>>
Type Parameters
- From extends Partition
- To extends Partition
Parameters
- from: [From, string, ...string[]]
- to: [To, string, ...string[]] | [To, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult<To>>
- Defined in packages/nest/src/class.ts:715

remove

remove(path, mutationOptions?): Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
}>
Parameters
- path: [Partition, string, ...string[]]
- mutationOptions: MutationOptions = {}
Returns Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:742

rename

rename(path, newName, mutationOptions?): Promise<MutationResult>
Type Parameters
- P extends Partition
Parameters
- path: [P, string, ...string[]]
- newName: string
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult>
- Defined in packages/nest/src/class.ts:763

write

write<P, D, V>(path, dataType, data, mutationOptions?): Promise<MutationResult>
Type Parameters
- P extends Partition
- D extends DataType
- V = unknown
Parameters
- path: [P, string, ...string[]]
- dataType: DataType
- data: DataForType<D, V>
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult>
- Defined in packages/nest/src/class.ts:783

Transacting

transaction

transaction(handler, mutationOptions?): Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
modifications: Modification[];
}>
Parameters
- handler: ((t) => Promise<void>)
 - - (t): Promise<void>
 - Parameters
 t: TransactionContext
 Returns Promise<void>
- mutationOptions: MutationOptions = {}
Returns Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
modifications: Modification[];
}>
- Defined in packages/nest/src/class.ts:963

Events

anyEvent

anyEvent(): AsyncIterable<[keyof Events, {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
} | {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
}]>
Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.

Call return() on the iterator to remove the subscription.

In the same way as for events, you can subscribe by using the for await statement.

Returns AsyncIterable<[keyof Events, {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
} | {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
}]>
- Defined in packages/nest/src/class.ts:238

events

events<Name>(eventName): AsyncIterable<Events[Name]>
Get an async iterator which buffers data each time an event is emitted.

Call return() on the iterator to remove the subscription.
Type Parameters
- Name extends keyof Events
Parameters
- eventName: Name
Returns AsyncIterable<Events[Name]>
- Defined in packages/nest/src/class.ts:247

off

off<Name>(eventName, listener): void
Remove one or more event subscriptions.
Type Parameters
- Name extends keyof Events
Parameters
- eventName: Name
- listener: Listener<Events, Name>
Returns void
- Defined in packages/nest/src/class.ts:200

offAny

offAny(listener): void
Remove an onAny subscription.
Parameters
- listener: ((eventName, eventData) => void | Promise<void>)
 - - (eventName, eventData): void | Promise<void>
 - Parameters
 eventName: keyof Events
 eventData: {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
 } | {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
 }
 Returns void | Promise<void>
Returns void
- Defined in packages/nest/src/class.ts:213

on

on<Name>(eventName, listener): UnsubscribeFunction
Subscribe to one or more events.

Using the same listener multiple times for the same event will result in only one method call per emitted event.
Type Parameters
- Name extends keyof Events
Parameters
- eventName: Name
- listener: Listener<Events, Name>
Returns UnsubscribeFunction
An unsubscribe method.
- Defined in packages/nest/src/class.ts:175

onAny

onAny(listener): UnsubscribeFunction
Subscribe to be notified about any event.
Parameters
- listener: ((eventName, eventData) => void | Promise<void>)
 - - (eventName, eventData): void | Promise<void>
 - Parameters
 eventName: keyof Events
 eventData: {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
 } | {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
 }
 Returns void | Promise<void>
Returns UnsubscribeFunction
A method to unsubscribe.
- Defined in packages/nest/src/class.ts:186

once

once<Name>(eventName): EmitteryOncePromise<(Events & OmnipresentEventData)[Name]>
Subscribe to one or more events only once. It will be unsubscribed after the first event.
Type Parameters
- Name extends keyof Events
Parameters
- eventName: Name
Returns EmitteryOncePromise<(Events & OmnipresentEventData)[Name]>
The promise of event data when eventName is emitted. This promise is extended with an off method.
- Defined in packages/nest/src/class.ts:228

Misc

calculateDataRoot

calculateDataRoot(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
- Defined in packages/nest/src/class.ts:1014

Methods

`Private` #infusedTransaction

#infusedTransaction(handler, path, mutationOptions?): Promise<{
 capsuleCID: CID<unknown, number, number, Version>;
 contentCID: CID<unknown, number, number, Version>;
 dataRoot: CID<unknown, number, number, Version>;
}>
Parameters
- handler: ((t) => Promise<void>)
 - - (t): Promise<void>
 - Parameters
 t: TransactionContext
 Returns Promise<void>
- path: [Path.Public, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<{
 capsuleCID: CID<unknown, number, number, Version>;
 contentCID: CID<unknown, number, number, Version>;
 dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:1020
#infusedTransaction(handler, path, mutationOptions?): Promise<{
capsuleKey: Uint8Array;
dataRoot: CID<unknown, number, number, Version>;
}>
Parameters
- handler: ((t) => Promise<void>)
 - - (t): Promise<void>
 - Parameters
 t: TransactionContext
 Returns Promise<void>
- path: [Path.Private, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<{
capsuleKey: Uint8Array;
dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:1025
#infusedTransaction(handler, path, mutationOptions?): Promise<MutationResult<Partition>>
Parameters
- handler: ((t) => Promise<void>)
 - - (t): Promise<void>
 - Parameters
 t: TransactionContext
 Returns Promise<void>
- path: [Partition, ...string[]]
- Optional mutationOptions: MutationOptions
Returns Promise<MutationResult<Partition>>
- Defined in packages/nest/src/class.ts:1030

`Private` #publish

#publish(dataRoot, modifications): Promise<void>
Parameters
- dataRoot: CID<unknown, number, number, Version>
- modifications: Modification[]
Returns Promise<void>
- Defined in packages/nest/src/class.ts:1143

`Private` #transactionContext

#transactionContext(): TransactionContext
Returns TransactionContext
- Defined in packages/nest/src/class.ts:1131

assignIdentifier

assignIdentifier(did, mutationOptions?): Promise<{
dataRoot: CID<unknown, number, number, Version>;
}>
Parameters
- did: string
- mutationOptions: MutationOptions = {}
Returns Promise<{
dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:807

identifier

identifier(): undefined | string
Returns undefined | string
- Defined in packages/nest/src/class.ts:825

Properties

`Private` `Readonly` #blockstore

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

Type declaration

`Private` `Readonly` #debouncedDataRootUpdate

#debouncedDataRootUpdate: ((...args) => Promise<void>)

Type declaration

- (...args): Promise<void>
- Parameters
 - Rest ...args: {
 dataRoot: CID<unknown, number, number, Version>;
 modifications: Modification[];
 }[]
 Returns Promise<void>

`Private` `Readonly` #eventEmitter

#eventEmitter: Emittery<Events, Events & OmnipresentEventData, never>

`Private` `Readonly` #onCommit

#onCommit: CommitVerifier

`Private` #privateNodes

#privateNodes: MountedPrivateNodes = {}

`Private` `Readonly` #rng

#rng: Rng

`Private` #rootTree

#rootTree: RootTree

Sharing

isExchangeKeyRegistered

isExchangeKeyRegistered(exchangePublicKey): Promise<boolean>
Check if an exchange key was already registered.
Parameters
- exchangePublicKey: Uint8Array | CryptoKey
Returns Promise<boolean>
- Defined in packages/nest/src/class.ts:838

receive

receive(sharerDataRoot, exchangeKeyPair, opts?): Promise<Share>
Load a shared item.

NOTE: A share can only be received if the exchange key was registered and the receiver is in possession of the associated private key.
Parameters
- sharerDataRoot: CID<unknown, number, number, Version>
 The data root CID from the sharer
- exchangeKeyPair: {
 privateKey: CryptoKey;
 publicKey: Uint8Array | CryptoKey;
 }
 A RSA-OAEP-256 key pair
 - privateKey: CryptoKey
 A RSA-OAEP-256 private key in the form of a CryptoKey
 - publicKey: Uint8Array | CryptoKey
 A RSA-OAEP-256 public key in the form of a CryptoKey or its modulus bytes
- opts: {
 shareId?: string;
 sharerBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
 sharerRootTreeClass?: typeof RootTree;
 } = {}
 Optional overrides
 - Optional shareId?: string
 Specify what shareId to use, otherwise this'll load the last share that was made to the given exchange key.
 - Optional sharerBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
 Specify what blockstore to use to load the sharer's file system.
 - Optional sharerRootTreeClass?: typeof RootTree
 Specify what root tree class was used for the sharer's file system.
Returns Promise<Share>
- Defined in packages/nest/src/class.ts:863

registerExchangeKey

registerExchangeKey(name, exchangePublicKey, mutationOptions?): Promise<{
dataRoot: CID<unknown, number, number, Version>;
}>
Register an exchange key.
Parameters
- name: string
 A name for the key (using an existing name overrides the old key)
- exchangePublicKey: Uint8Array | CryptoKey
 A RSA-OAEP-256 public key in the form of a CryptoKey or its modulus bytes
- mutationOptions: MutationOptions = {}
 Mutation options
Returns Promise<{
dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:891

share(path, receiverDataRoot, opts?): Promise<{
 shareId: string;
} & {
 capsuleKey: Uint8Array;
 dataRoot: CID<unknown, number, number, Version>;
}>
Share a private file or directory.

NOTE: A share can only be received if the exchange key was registered and the receiver is in possession of the associated private key.
Parameters
- path: [Path.Private, ...string[]]
 Path to the private file or directory to share (with 'private' prefix)
- receiverDataRoot: CID<unknown, number, number, Version>
 Data root CID of the receiver
- opts: {
 mutationOptions?: MutationOptions;
 receiverBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
 receiverRootTreeClass?: typeof RootTree;
 } = {}
 Optional overrides
 - Optional mutationOptions?: MutationOptions
 Mutation options
 - Optional receiverBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
 Specify what blockstore to use to load the receiver's file system
 - Optional receiverRootTreeClass?: typeof RootTree
 Specify what root tree class was used for the receiver's file system
Returns Promise<{
 shareId: string;
} & {
 capsuleKey: Uint8Array;
 dataRoot: CID<unknown, number, number, Version>;
}>
- Defined in packages/nest/src/class.ts:925

Class FileSystem

Index

🪺 :: START HERE

Mounting

Querying

Mutating

Transacting

Events

Misc

Methods

Properties

Sharing

🪺 :: START HERE

Static create

Parameters

Returns Promise<FileSystem>

Static fromCID

Parameters

Returns Promise<FileSystem>

Mounting

createPrivateNode

Parameters

exchangeKeyPair: { privateKey: CryptoKey; publicKey: Uint8Array | CryptoKey; }

privateKey: CryptoKey

publicKey: Uint8Array | CryptoKey

Optional kind?: Kind

path: Segments

Returns Promise<{ capsuleKey: Uint8Array; path: [Path.Private, ...string[]]; shareId: string; }>

Parameters

Optional kind?: Kind

path: Segments

Returns Promise<{ capsuleKey: Uint8Array; path: [Path.Private, ...string[]]; }>

mountPrivateNode

Parameters

Returns Promise<void>

mountPrivateNodes

Parameters

Returns Promise<void>

unmountPrivateNode

Parameters

Returns void

Querying

ls

Type declaration

Parameters

withItemKind: true

Returns Promise<DirectoryItemWithKind[]>

Parameters

withItemKind: false

Returns Promise<DirectoryItem[]>

Parameters

Returns Promise<DirectoryItem[]>

Parameters

withItemKind: boolean

Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

capsuleCID

Parameters

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

capsuleKey

Parameters

Returns Promise<undefined | Uint8Array>

contentCID

Parameters

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

exists

Parameters

Returns Promise<boolean>

listDirectory

Parameters

withItemKind: true

Returns Promise<DirectoryItemWithKind[]>

Parameters

withItemKind: false

Returns Promise<DirectoryItem[]>

Parameters

Returns Promise<DirectoryItem[]>

Parameters

withItemKind: boolean

Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

read

`Static` create

`Static` fromCID

exchangeKeyPair: {
privateKey: CryptoKey;
publicKey: Uint8Array | CryptoKey;
}

`Optional` kind?: Kind

Returns Promise<{
capsuleKey: Uint8Array;
path: [Path.Private, ...string[]];
shareId: string;
}>

`Optional` kind?: Kind

Returns Promise<{
capsuleKey: Uint8Array;
path: [Path.Private, ...string[]];
}>

`Optional` length?: number

`Optional` offset?: number

Returns Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
}>

Returns Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>

Returns Promise<MutationResult<P, {
path: [Partition, string, ...string[]];
}>>

Returns Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
}>

Returns Promise<"no-op" | {
dataRoot: CID<unknown, number, number, Version>;
modifications: Modification[];
}>

Returns AsyncIterable<[keyof Events, {
dataRoot: CID<unknown, number, number, Version>;
modifications: Modification[];
} | {
dataRoot: CID<unknown, number, number, Version>;
modifications: Modification[];
}]>