Class default

Hierarchy

BaseTree
- default

Constructors

constructor

new default(__namedParameters: ConstructorParams): default
Parameters
- __namedParameters: ConstructorParams
Returns default
Overrides BaseTree.constructor
- Defined in fs/v1/PrivateTree.ts:55

Properties

children

children: {
[name: string]: default | PrivateFile;
}

Type declaration

[name: string]: default | PrivateFile

history

history: default

key

key: Uint8Array

manners

manners: Manners.Implementation

mmpt

mmpt: default

readOnly

readOnly: boolean

reference

reference: Reference.Implementation

Methods

add

add(path: Segments, content: Uint8Array): Promise<default>
Parameters
- path: Segments
- content: Uint8Array
Returns Promise<default>
Inherited from BaseTree.add
- Defined in fs/base/tree.ts:69

addRecurse

addRecurse(path: Segments, content: Uint8Array, onUpdate: Maybe<UpdateCallback>): Promise<default>
Parameters
- path: Segments
- content: Uint8Array
- onUpdate: Maybe<UpdateCallback>
Returns Promise<default>
Inherited from BaseTree.addRecurse
- Defined in fs/base/tree.ts:74

assignLink

assignLink(__namedParameters: {
    link: SoftLink | PrivateLink;
    name: string;
    skeleton: SoftLink | PrivateSkeletonInfo;
}): void
Parameters
- __namedParameters: {
      link: SoftLink | PrivateLink;
      name: string;
      skeleton: SoftLink | PrivateSkeletonInfo;
  }
  - link: SoftLink | PrivateLink
  - name: string
  - skeleton: SoftLink | PrivateSkeletonInfo
Returns void
- Defined in fs/v1/PrivateTree.ts:349

cat

cat(path: Segments): Promise<Uint8Array>
Parameters
- path: Segments
Returns Promise<Uint8Array>
Inherited from BaseTree.cat
- Defined in fs/base/tree.ts:35

createChildTree

createChildTree(name: string, onUpdate: Maybe<UpdateCallback>): Promise<default>
Parameters
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<default>
Overrides BaseTree.createChildTree
- Defined in fs/v1/PrivateTree.ts:188

createOrUpdateChildFile

createOrUpdateChildFile(content: Uint8Array, name: string, onUpdate: Maybe<UpdateCallback>): Promise<PrivateFile>
Parameters
- content: Uint8Array
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<PrivateFile>
Overrides BaseTree.createOrUpdateChildFile
- Defined in fs/v1/PrivateTree.ts:204

exists

exists(path: Segments): Promise<boolean>
Parameters
- path: Segments
Returns Promise<boolean>
Inherited from BaseTree.exists
- Defined in fs/base/tree.ts:170

get

get(path: Segments): Promise<null | PrivateFile | default>
Parameters
- path: Segments
Returns Promise<null | PrivateFile | default>
Overrides BaseTree.get
- Defined in fs/v1/PrivateTree.ts:297

getDirectChild

getDirectChild(name: string): Promise<null | PrivateFile | default>
Parameters
- name: string
Returns Promise<null | PrivateFile | default>
Overrides BaseTree.getDirectChild
- Defined in fs/v1/PrivateTree.ts:253

getLinks

getLinks(): Links
Returns Links
Overrides BaseTree.getLinks
- Defined in fs/v1/PrivateTree.ts:396

getName

getName(): Promise<PrivateName>
Returns Promise<PrivateName>
- Defined in fs/v1/PrivateTree.ts:286

getOrCreateDirectChild

getOrCreateDirectChild(name: string, onUpdate: Maybe<UpdateCallback>): Promise<File | Tree>
Parameters
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<File | Tree>
Inherited from BaseTree.getOrCreateDirectChild
- Defined in fs/base/tree.ts:183

getRecurse

getRecurse(nodeInfo: SoftLink | PrivateSkeletonInfo, parts: string[]): Promise<null | PrivateFile | default>
Parameters
- nodeInfo: SoftLink | PrivateSkeletonInfo
- parts: string[]
Returns Promise<null | PrivateFile | default>
- Defined in fs/v1/PrivateTree.ts:308

insertSoftLink

insertSoftLink(__namedParameters: {
    key: Uint8Array;
    name: string;
    privateName: PrivateName;
    username: string;
}): default
Parameters
- __namedParameters: {
      key: Uint8Array;
      name: string;
      privateName: PrivateName;
      username: string;
  }
  - key: Uint8Array
  - name: string
  - privateName: PrivateName
  - username: string
Returns default
- Defined in fs/v1/PrivateTree.ts:419

ls

ls(path: Segments): Promise<Links>
Parameters
- path: Segments
Returns Promise<Links>
Inherited from BaseTree.ls
- Defined in fs/base/tree.ts:25

mkdir

mkdir(path: Segments): Promise<default>
Parameters
- path: Segments
Returns Promise<default>
Inherited from BaseTree.mkdir
- Defined in fs/base/tree.ts:45

mkdirRecurse

mkdirRecurse(path: Segments, onUpdate: Maybe<UpdateCallback>): Promise<default>
Parameters
- path: Segments
- onUpdate: Maybe<UpdateCallback>
Returns Promise<default>
Inherited from BaseTree.mkdirRecurse
- Defined in fs/base/tree.ts:49

mv

mv(from: Segments, to: Segments): Promise<default>
Parameters
- from: Segments
- to: Segments
Returns Promise<default>
Inherited from BaseTree.mv
- Defined in fs/base/tree.ts:130

put

put(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
Inherited from BaseTree.put
- Defined in fs/base/tree.ts:20

putDetailed

putDetailed(): Promise<PrivateAddResult>
Returns Promise<PrivateAddResult>
Overrides BaseTree.putDetailed
- Defined in fs/v1/PrivateTree.ts:220

read

read(path: Segments): Promise<null | File | Tree>
Parameters
- path: Segments
Returns Promise<null | File | Tree>
Inherited from BaseTree.read
- Defined in fs/base/tree.ts:175

removeDirectChild

removeDirectChild(name: string): default
Parameters
- name: string
Returns default
Overrides BaseTree.removeDirectChild
- Defined in fs/v1/PrivateTree.ts:240

rm

rm(path: Segments): Promise<default>
Parameters
- path: Segments
Returns Promise<default>
Inherited from BaseTree.rm
- Defined in fs/base/tree.ts:98

rmRecurse

rmRecurse(path: Segments, onUpdate: Maybe<UpdateCallback>): Promise<default>
Parameters
- path: Segments
- onUpdate: Maybe<UpdateCallback>
Returns Promise<default>
Inherited from BaseTree.rmRecurse
- Defined in fs/base/tree.ts:103

updateChild

updateChild(child: File | Tree, path: Segments): Promise<default>
put is called on child (result of promise) in updateDirectChild Then for the outermost parent, put should be called manually.
Parameters
- child: File | Tree
- path: Segments
Returns Promise<default>
Inherited from BaseTree.updateChild
- Defined in fs/base/tree.ts:194

updateDirectChild

updateDirectChild(child: PrivateFile | default, name: string, onUpdate: Maybe<UpdateCallback>): Promise<default>
Parameters
- child: PrivateFile | default
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<default>
Overrides BaseTree.updateDirectChild
- Defined in fs/v1/PrivateTree.ts:230

updateLink

updateLink(name: string, result: PrivateAddResult): default
Parameters
- name: string
- result: PrivateAddResult
Returns default
Overrides BaseTree.updateLink
- Defined in fs/v1/PrivateTree.ts:407

updateParentNameFilter

updateParentNameFilter(parentNameFilter: BareNameFilter): Promise<default>
Parameters
- parentNameFilter: BareNameFilter
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:292

write

write(path: Segments, content: Uint8Array): Promise<default>
Parameters
- path: Segments
- content: Uint8Array
Returns Promise<default>
Inherited from BaseTree.write
- Defined in fs/base/tree.ts:179

`Static` create

create(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, key: Uint8Array, parentNameFilter: Maybe<BareNameFilter>): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- key: Uint8Array
- parentNameFilter: Maybe<BareNameFilter>
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:91

`Static` fromBareNameFilter

fromBareNameFilter(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, bareNameFilter: BareNameFilter, key: Uint8Array): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- bareNameFilter: BareNameFilter
- key: Uint8Array
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:133

`Static` fromBaseKey

fromBaseKey(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, key: Uint8Array): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- key: Uint8Array
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:121

`Static` fromInfo

fromInfo(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, key: Uint8Array, info: Maybe<DecryptedNode>): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- key: Uint8Array
- info: Maybe<DecryptedNode>
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:172

`Static` fromLatestName

fromLatestName(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, name: PrivateName, key: Uint8Array): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- name: PrivateName
- key: Uint8Array
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:146

`Static` fromName

fromName(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, mmpt: default, name: PrivateName, key: Uint8Array): Promise<default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- mmpt: default
- name: PrivateName
- key: Uint8Array
Returns Promise<default>
- Defined in fs/v1/PrivateTree.ts:159

`Static` instanceOf

instanceOf(obj: unknown): obj is default
Parameters
- obj: unknown
Returns obj is default
- Defined in fs/v1/PrivateTree.ts:84

`Static` resolveSoftLink

resolveSoftLink(crypto: Crypto.Implementation, depot: Depot.Implementation, manners: Manners.Implementation, reference: Reference.Implementation, link: SoftLink): Promise<null | PrivateFile | default>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- manners: Manners.Implementation
- reference: Reference.Implementation
- link: SoftLink
Returns Promise<null | PrivateFile | default>
- Defined in fs/v1/PrivateTree.ts:360

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: ConstructorParams

Returns default

Properties

children

Type declaration

[name: string]: default | PrivateFile

crypto

depot

header

history

key

manners

mmpt

readOnly

reference

Methods

add

Parameters

path: Segments

content: Uint8Array

Returns Promise<default>

addRecurse

Parameters

path: Segments

content: Uint8Array

onUpdate: Maybe<UpdateCallback>

Returns Promise<default>

assignLink

Parameters

__namedParameters: { link: SoftLink | PrivateLink; name: string; skeleton: SoftLink | PrivateSkeletonInfo; }

link: SoftLink | PrivateLink

name: string

skeleton: SoftLink | PrivateSkeletonInfo

Returns void

cat

Parameters

path: Segments

Returns Promise<Uint8Array>

createChildTree

Parameters

name: string

onUpdate: Maybe<UpdateCallback>

Returns Promise<default>

createOrUpdateChildFile

Parameters

content: Uint8Array

name: string

onUpdate: Maybe<UpdateCallback>

Returns Promise<PrivateFile>

exists

Parameters

path: Segments

Returns Promise<boolean>

get

Parameters

path: Segments

Returns Promise<null | PrivateFile | default>

getDirectChild

Parameters

name: string

Returns Promise<null | PrivateFile | default>

getLinks

Returns Links

getName

Returns Promise<PrivateName>

getOrCreateDirectChild

Parameters

name: string

onUpdate: Maybe<UpdateCallback>

Returns Promise<File | Tree>

getRecurse

__namedParameters: {
link: SoftLink | PrivateLink;
name: string;
skeleton: SoftLink | PrivateSkeletonInfo;
}

__namedParameters: {
key: Uint8Array;
name: string;
privateName: PrivateName;
username: string;
}