Class default

Hierarchy

default

Implements

Puttable

Constructors

constructor

new default(__namedParameters: { links: SimpleLinks; mmpt: <internal>.default; prettyTree: BareTree; privateLog: SimpleLink[]; privateNodes: Record<string, PrivateNode>; publicTree: PublicTree; sharedCounter: number; sharedLinks: SimpleLinks }): <internal>.default

- Defined in fs/root/tree.ts:47
Parameters
- __namedParameters: { links: SimpleLinks; mmpt: <internal>.default; prettyTree: BareTree; privateLog: SimpleLink[]; privateNodes: Record<string, PrivateNode>; publicTree: PublicTree; sharedCounter: number; sharedLinks: SimpleLinks }
  - links: SimpleLinks
  - mmpt: <internal>.default
  - prettyTree: BareTree
  - privateLog: SimpleLink[]
  - privateNodes: Record<string, PrivateNode>
  - publicTree: PublicTree
  - sharedCounter: number
  - sharedLinks: SimpleLinks
Returns <internal>.default

Properties

links

links: SimpleLinks

mmpt

mmpt: <internal>.default

prettyTree

prettyTree: BareTree

privateLog

privateLog: SimpleLink[]

privateNodes

privateNodes: Record<string, PrivateNode>

publicTree

publicTree: PublicTree

sharedCounter

sharedCounter: number

sharedLinks

sharedLinks: SimpleLinks

Static LOG_CHUNK_SIZE

LOG_CHUNK_SIZE: number = 1020

Methods

addPrivateLogEntry

addPrivateLogEntry(cid: CID): Promise<void>

- Defined in fs/root/tree.ts:237
Parameters
- cid: CID
Returns Promise<void>

addShares

addShares(links: SimpleLink[]): Promise<<internal>.default>

- Defined in fs/root/tree.ts:284
Parameters
- links: SimpleLink[]
Returns Promise<<internal>.default>

bumpSharedCounter

bumpSharedCounter(): Promise<number>

- Defined in fs/root/tree.ts:351
Returns Promise<number>

findPrivateNode

findPrivateNode(path: DistinctivePath): [DistinctivePath, null | PrivateNode]

- Defined in fs/root/tree.ts:222
Parameters
- path: DistinctivePath
Returns [DistinctivePath, null | PrivateNode]

getVersion

getVersion(): Promise<null | SemVer>

- Defined in fs/root/tree.ts:365
Returns Promise<null | SemVer>

put

put(): Promise<CID>

Implementation of Puttable.put
- Defined in fs/root/tree.ts:193
Returns Promise<CID>

putDetailed

putDetailed(): Promise<AddResult>

Implementation of Puttable.putDetailed
- Defined in fs/root/tree.ts:198
Returns Promise<AddResult>

setSharedCounter

setSharedCounter(counter: number): Promise<number>

- Defined in fs/root/tree.ts:335
Parameters
- counter: number
Returns Promise<number>

setVersion

setVersion(v: SemVer): Promise<<internal>.default>

- Defined in fs/root/tree.ts:360
Parameters
- v: SemVer
Returns Promise<<internal>.default>

updateLink

updateLink(name: string, result: AddResult): <internal>.default

- Defined in fs/root/tree.ts:202
Parameters
- name: string
- result: AddResult
Returns <internal>.default

updatePuttable

updatePuttable(name: string, puttable: Puttable): Promise<<internal>.default>

- Defined in fs/root/tree.ts:208
Parameters
- name: string
- puttable: Puttable
Returns Promise<<internal>.default>

Static empty

empty(__namedParameters: { rootKey: string }): Promise<<internal>.default>

- Defined in fs/root/tree.ts:75
Parameters
- __namedParameters: { rootKey: string }
  - rootKey: string
Returns Promise<<internal>.default>

Static fromCID

fromCID(__namedParameters: { cid: CID; permissions?: Permissions }): Promise<<internal>.default>

- Defined in fs/root/tree.ts:117
Parameters
- __namedParameters: { cid: CID; permissions?: Permissions }
  - cid: CID
  - Optional permissions?: Permissions
Returns Promise<<internal>.default>

Static getSharedLinks

getSharedLinks(cid: CID): Promise<SimpleLinks>

- Defined in fs/root/tree.ts:312
Parameters
- cid: CID
Returns Promise<SimpleLinks>

Static storeRootKey

storeRootKey(rootKey: string): Promise<void>

- Defined in fs/root/tree.ts:216
Parameters
- rootKey: string
Returns Promise<void>

Generated using TypeDoc