Interface Tree

Hierarchy

UnixTree
Puttable
- Tree

Implemented by

BaseTree

Properties

readOnly

readOnly: boolean

Methods

add

add(path: Segments, content: Uint8Array): Promise<Tree>
Parameters
- path: Segments
- content: Uint8Array
Returns Promise<Tree>
Inherited from UnixTree.add
- Defined in fs/types.ts:146

addRecurse

addRecurse(path: Segments, content: Uint8Array, onUpdate: Maybe<UpdateCallback>): Promise<Tree>
Parameters
- path: Segments
- content: Uint8Array
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
- Defined in fs/types.ts:158

cat

cat(path: Segments): Promise<Uint8Array>
Parameters
- path: Segments
Returns Promise<Uint8Array>
Inherited from UnixTree.cat
- Defined in fs/types.ts:145

createChildTree

createChildTree(name: string, onUpdate: Maybe<UpdateCallback>): Promise<Tree>
Parameters
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
- Defined in fs/types.ts:154

createOrUpdateChildFile

createOrUpdateChildFile(content: Uint8Array, name: string, onUpdate: Maybe<UpdateCallback>): Promise<File>
Parameters
- content: Uint8Array
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<File>
- Defined in fs/types.ts:155

exists

exists(path: Segments): Promise<boolean>
Parameters
- path: Segments
Returns Promise<boolean>
Inherited from UnixTree.exists
- Defined in fs/types.ts:150

get

get(path: Segments): Promise<null | File | Tree>
Parameters
- path: Segments
Returns Promise<null | File | Tree>
Overrides UnixTree.get
- Defined in fs/types.ts:164

getDirectChild

getDirectChild(name: string): Promise<null | File | Tree>
Parameters
- name: string
Returns Promise<null | File | Tree>
- Defined in fs/types.ts:165

getLinks

getLinks(): Links
Returns Links
- Defined in fs/types.ts:169

getOrCreateDirectChild

getOrCreateDirectChild(name: string, onUpdate: Maybe<UpdateCallback>): Promise<File | Tree>
Parameters
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<File | Tree>
- Defined in fs/types.ts:166

ls

ls(path: Segments): Promise<Links>
Parameters
- path: Segments
Returns Promise<Links>
Inherited from UnixTree.ls
- Defined in fs/types.ts:143

mkdir

mkdir(path: Segments): Promise<Tree>
Parameters
- path: Segments
Returns Promise<Tree>
Inherited from UnixTree.mkdir
- Defined in fs/types.ts:144

mkdirRecurse

mkdirRecurse(path: Segments, onUpdate: Maybe<UpdateCallback>): Promise<Tree>
Parameters
- path: Segments
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
- Defined in fs/types.ts:157

mv

mv(from: Segments, to: Segments): Promise<Tree>
Parameters
- from: Segments
- to: Segments
Returns Promise<Tree>
Inherited from UnixTree.mv
- Defined in fs/types.ts:148

put

put(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
Inherited from Puttable.put
- Defined in fs/types.ts:116

putDetailed

putDetailed(): Promise<PutResult>
Returns Promise<PutResult>
Inherited from Puttable.putDetailed
- Defined in fs/types.ts:117

removeDirectChild

removeDirectChild(name: string): Tree
Parameters
- name: string
Returns Tree
- Defined in fs/types.ts:163

rm

rm(path: Segments): Promise<Tree>
Parameters
- path: Segments
Returns Promise<Tree>
Inherited from UnixTree.rm
- Defined in fs/types.ts:147

rmRecurse

rmRecurse(path: Segments, onUpdate: Maybe<UpdateCallback>): Promise<Tree>
Parameters
- path: Segments
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
- Defined in fs/types.ts:159

updateChild

updateChild(child: File | Tree, path: Segments): Promise<Tree>
Parameters
- child: File | Tree
- path: Segments
Returns Promise<Tree>
- Defined in fs/types.ts:161

updateDirectChild

updateDirectChild(child: File | Tree, name: string, onUpdate: Maybe<UpdateCallback>): Promise<Tree>
Parameters
- child: File | Tree
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
- Defined in fs/types.ts:162

updateLink

updateLink(name: string, result: PutResult): Tree
Parameters
- name: string
- result: PutResult
Returns Tree
- Defined in fs/types.ts:168

Generated using TypeDoc