Class default

Hierarchy

default

Implements

Puttable

Index

Constructors

constructor

new default(__namedParameters: {
    dependencies: Dependencies;
    links: SimpleLinks;
    mmpt: default;
    prettyTree: BareTree;
    privateLog: SimpleLink[];
    privateNodes: Record<string, PrivateNode>;
    publicTree: UnixTree & Puttable;
    sharedCounter: number;
    sharedLinks: SimpleLinks;
}): default
Parameters
- __namedParameters: {
      dependencies: Dependencies;
      links: SimpleLinks;
      mmpt: default;
      prettyTree: BareTree;
      privateLog: SimpleLink[];
      privateNodes: Record<string, PrivateNode>;
      publicTree: UnixTree & Puttable;
      sharedCounter: number;
      sharedLinks: SimpleLinks;
  }
  - dependencies: Dependencies
  - links: SimpleLinks
  - mmpt: default
  - prettyTree: BareTree
  - privateLog: SimpleLink[]
  - privateNodes: Record<string, PrivateNode>
  - publicTree: UnixTree & Puttable
  - sharedCounter: number
  - sharedLinks: SimpleLinks
Returns default
- Defined in fs/root/tree.ts:69

Properties

dependencies

dependencies: Dependencies

links

links: SimpleLinks

mmpt

mmpt: default

prettyTree

prettyTree: BareTree

privateLog

privateLog: SimpleLink[]

privateNodes

privateNodes: Record<string, PrivateNode>

publicTree

publicTree: UnixTree & Puttable

sharedCounter

sharedCounter: number

sharedLinks

sharedLinks: SimpleLinks

`Static` LOG_CHUNK_SIZE

LOG_CHUNK_SIZE: number = 1020

Methods

addPrivateLogEntry

addPrivateLogEntry(depot: Depot.Implementation, cid: CID<unknown, number, number, Version>): Promise<void>
Parameters
- depot: Depot.Implementation
- cid: CID<unknown, number, number, Version>
Returns Promise<void>
- Defined in fs/root/tree.ts:289

addShares

addShares(links: SimpleLink[]): Promise<default>
Parameters
- links: SimpleLink[]
Returns Promise<default>
- Defined in fs/root/tree.ts:342

bumpSharedCounter

bumpSharedCounter(): Promise<number>
Returns Promise<number>
- Defined in fs/root/tree.ts:409

findPrivateNode

findPrivateNode(path: DistinctivePath<Segments>): [DistinctivePath<Segments>, null | PrivateNode]
Parameters
- path: DistinctivePath<Segments>
Returns [DistinctivePath<Segments>, null | PrivateNode]
- Defined in fs/root/tree.ts:274

getVersion

getVersion(): Promise<null | SemVer>
Returns Promise<null | SemVer>
- Defined in fs/root/tree.ts:424

put

put(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
Implementation of Puttable.put
- Defined in fs/root/tree.ts:251

putDetailed

putDetailed(): Promise<PutResult>
Returns Promise<PutResult>
Implementation of Puttable.putDetailed
- Defined in fs/root/tree.ts:256

setSharedCounter

setSharedCounter(counter: number): Promise<number>
Parameters
- counter: number
Returns Promise<number>
- Defined in fs/root/tree.ts:392

setVersion

setVersion(v: SemVer): Promise<default>
Parameters
- v: SemVer
Returns Promise<default>
- Defined in fs/root/tree.ts:418

updateLink

updateLink(name: string, result: PutResult): default
Parameters
- name: string
- result: PutResult
Returns default
- Defined in fs/root/tree.ts:260

updatePuttable

updatePuttable(name: string, puttable: Puttable): Promise<default>
Parameters
- name: string
- puttable: Puttable
Returns Promise<default>
- Defined in fs/root/tree.ts:266

`Static` empty

empty(__namedParameters: {
    accountDID: string;
    dependencies: Dependencies;
    rootKey: Uint8Array;
    wnfsWasm?: boolean;
}): Promise<default>
Parameters
- __namedParameters: {
      accountDID: string;
      dependencies: Dependencies;
      rootKey: Uint8Array;
      wnfsWasm?: boolean;
  }
  - accountDID: string
  - dependencies: Dependencies
  - rootKey: Uint8Array
  - Optional wnfsWasm?: boolean
Returns Promise<default>
- Defined in fs/root/tree.ts:101

`Static` fromCID

fromCID(__namedParameters: {
    accountDID: string;
    cid: CID<unknown, number, number, Version>;
    dependencies: Dependencies;
    permissions?: Permissions;
}): Promise<default>
Parameters
- __namedParameters: {
      accountDID: string;
      cid: CID<unknown, number, number, Version>;
      dependencies: Dependencies;
      permissions?: Permissions;
  }
  - accountDID: string
  - cid: CID<unknown, number, number, Version>
  - dependencies: Dependencies
  - Optional permissions?: Permissions
Returns Promise<default>
- Defined in fs/root/tree.ts:157

`Static` getSharedLinks

getSharedLinks(depot: Depot.Implementation, cid: CID<unknown, number, number, Version>): Promise<SimpleLinks>
Parameters
- depot: Depot.Implementation
- cid: CID<unknown, number, number, Version>
Returns Promise<SimpleLinks>
- Defined in fs/root/tree.ts:370

Class default

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { dependencies: Dependencies; links: SimpleLinks; mmpt: default; prettyTree: BareTree; privateLog: SimpleLink[]; privateNodes: Record<string, PrivateNode>; publicTree: UnixTree & Puttable; sharedCounter: number; sharedLinks: SimpleLinks; }

dependencies: Dependencies

links: SimpleLinks

mmpt: default

prettyTree: BareTree

privateLog: SimpleLink[]

privateNodes: Record<string, PrivateNode>

publicTree: UnixTree & Puttable

sharedCounter: number

sharedLinks: SimpleLinks

Returns default

Properties

dependencies

links

mmpt

prettyTree

privateLog

privateNodes

publicTree

sharedCounter

sharedLinks

Static LOG_CHUNK_SIZE

Methods

addPrivateLogEntry

Parameters

depot: Depot.Implementation

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

Returns Promise<void>

addShares

Parameters

links: SimpleLink[]

Returns Promise<default>

bumpSharedCounter

Returns Promise<number>

findPrivateNode

Parameters

path: DistinctivePath<Segments>

Returns [DistinctivePath<Segments>, null | PrivateNode]

getVersion

Returns Promise<null | SemVer>

put

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

putDetailed

Returns Promise<PutResult>

setSharedCounter

Parameters

counter: number

Returns Promise<number>

setVersion

Parameters

v: SemVer

Returns Promise<default>

updateLink

Parameters

name: string

result: PutResult

Returns default

updatePuttable

Parameters

name: string

puttable: Puttable

Returns Promise<default>

Static empty

Parameters

__namedParameters: { accountDID: string; dependencies: Dependencies; rootKey: Uint8Array; wnfsWasm?: boolean; }

accountDID: string

dependencies: Dependencies

rootKey: Uint8Array

Optional wnfsWasm?: boolean

Returns Promise<default>

__namedParameters: {
dependencies: Dependencies;
links: SimpleLinks;
mmpt: default;
prettyTree: BareTree;
privateLog: SimpleLink[];
privateNodes: Record<string, PrivateNode>;
publicTree: UnixTree & Puttable;
sharedCounter: number;
sharedLinks: SimpleLinks;
}

`Static` LOG_CHUNK_SIZE

`Static` empty

__namedParameters: {
accountDID: string;
dependencies: Dependencies;
rootKey: Uint8Array;
wnfsWasm?: boolean;
}

`Optional` wnfsWasm?: boolean

`Static` fromCID

__namedParameters: {
accountDID: string;
cid: CID<unknown, number, number, Version>;
dependencies: Dependencies;
permissions?: Permissions;
}

`Optional` permissions?: Permissions

`Static` getSharedLinks