Class BareTree

Hierarchy

BaseTree
- BareTree

Index

Constructors

constructor

new BareTree(depot: Depot.Implementation, links: HardLinks): BareTree
Parameters
- depot: Depot.Implementation
- links: HardLinks
Returns BareTree
Overrides BaseTree.constructor
- Defined in fs/bare/tree.ts:24

Properties

children

children: {
[name: string]: Tree | File;
}

Type declaration

[name: string]: Tree | File

depot

depot: Depot.Implementation

links

links: HardLinks

readOnly

readOnly: boolean

type

type: "BareTree"

Methods

add

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

addRecurse

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

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<Tree>
Parameters
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<Tree>
Overrides BaseTree.createChildTree
- Defined in fs/bare/tree.ts:56

createOrUpdateChildFile

createOrUpdateChildFile(content: Uint8Array, name: string, onUpdate: Maybe<UpdateCallback>): Promise<BareFile>
Parameters
- content: Uint8Array
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<BareFile>
Overrides BaseTree.createOrUpdateChildFile
- Defined in fs/bare/tree.ts:71

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 | File | Tree>
Parameters
- path: Segments
Returns Promise<null | File | Tree>
Overrides BaseTree.get
- Defined in fs/bare/tree.ts:130

getDirectChild

getDirectChild(name: string): Promise<null | File | Tree>
Parameters
- name: string
Returns Promise<null | File | Tree>
Overrides BaseTree.getDirectChild
- Defined in fs/bare/tree.ts:109

getLinks

getLinks(): BaseLinks
Returns BaseLinks
Overrides BaseTree.getLinks
- Defined in fs/bare/tree.ts:151

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

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<BareTree>
Parameters
- path: Segments
Returns Promise<BareTree>
Inherited from BaseTree.mkdir
- Defined in fs/base/tree.ts:45

mkdirRecurse

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

mv

mv(from: Segments, to: Segments): Promise<BareTree>
Parameters
- from: Segments
- to: Segments
Returns Promise<BareTree>
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

putAndUpdateLink

putAndUpdateLink(child: Puttable, name: string, onUpdate: Maybe<UpdateCallback>): Promise<BareTree>
Parameters
- child: Puttable
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<BareTree>
- Defined in fs/bare/tree.ts:89

putDetailed

putDetailed(): Promise<PutResult>
Returns Promise<PutResult>
Overrides BaseTree.putDetailed
- Defined in fs/bare/tree.ts:85

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): BareTree
Parameters
- name: string
Returns BareTree
Overrides BaseTree.removeDirectChild
- Defined in fs/bare/tree.ts:101

rm

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

rmRecurse

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

updateChild

updateChild(child: File | Tree, path: Segments): Promise<BareTree>
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<BareTree>
Inherited from BaseTree.updateChild
- Defined in fs/base/tree.ts:194

updateDirectChild

updateDirectChild(child: File | Tree, name: string, onUpdate: Maybe<UpdateCallback>): Promise<BareTree>
Parameters
- child: File | Tree
- name: string
- onUpdate: Maybe<UpdateCallback>
Returns Promise<BareTree>
Overrides BaseTree.updateDirectChild
- Defined in fs/bare/tree.ts:96

updateLink

updateLink(name: string, result: PutResult): BareTree
Parameters
- name: string
- result: PutResult
Returns BareTree
Overrides BaseTree.updateLink
- Defined in fs/bare/tree.ts:145

write

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

`Static` empty

empty(depot: Depot.Implementation): Promise<BareTree>
Parameters
- depot: Depot.Implementation
Returns Promise<BareTree>
- Defined in fs/bare/tree.ts:32

`Static` fromCID

fromCID(depot: Depot.Implementation, cid: CID<unknown, number, number, Version>): Promise<BareTree>
Parameters
- depot: Depot.Implementation
- cid: CID<unknown, number, number, Version>
Returns Promise<BareTree>
- Defined in fs/bare/tree.ts:36

`Static` fromLinks

fromLinks(depot: Depot.Implementation, links: HardLinks): BareTree
Parameters
- depot: Depot.Implementation
- links: HardLinks
Returns BareTree
- Defined in fs/bare/tree.ts:44

`Static` instanceOf

instanceOf(obj: unknown): obj is BareTree
Parameters
- obj: unknown
Returns obj is BareTree
- Defined in fs/bare/tree.ts:48

Generated using TypeDoc