Class PrivateFile

Hierarchy

BaseFile
- PrivateFile

Index

Constructors

Properties

content crypto depot header history key mmpt readOnly

Methods

getName put putDetailed updateContent updateParentNameFilter create fromBareNameFilter fromInfo fromLatestName fromName instanceOf

Constructors

constructor

new PrivateFile(__namedParameters: ConstructorParams): PrivateFile
Parameters
- __namedParameters: ConstructorParams
Returns PrivateFile
Overrides BaseFile.constructor
- Defined in fs/v1/PrivateFile.ts:45

Properties

content

content: Uint8Array

crypto

crypto: Crypto.Implementation

depot

depot: Depot.Implementation

header

header: PrivateFileInfo

history

history: default

key

key: Uint8Array

mmpt

readOnly

readOnly: boolean

Methods

getName

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

put

put(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
Inherited from BaseFile.put
- Defined in fs/base/file.ts:17

putDetailed

putDetailed(): Promise<PrivateAddResult>
Returns Promise<PrivateAddResult>
Overrides BaseFile.putDetailed
- Defined in fs/v1/PrivateFile.ts:209

updateContent

updateContent(content: Uint8Array): Promise<PrivateFile>
Parameters
- content: Uint8Array
Returns Promise<PrivateFile>
Overrides BaseFile.updateContent
- Defined in fs/v1/PrivateFile.ts:192

updateParentNameFilter

updateParentNameFilter(parentNameFilter: BareNameFilter): Promise<PrivateFile>
Parameters
- parentNameFilter: BareNameFilter
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:180

`Static` create

create(crypto: Crypto.Implementation, depot: Depot.Implementation, mmpt: default, content: Uint8Array, parentNameFilter: BareNameFilter, key: Uint8Array): Promise<PrivateFile>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- mmpt: default
- content: Uint8Array
- parentNameFilter: BareNameFilter
- key: Uint8Array
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:79

`Static` fromBareNameFilter

fromBareNameFilter(crypto: Crypto.Implementation, depot: Depot.Implementation, mmpt: default, bareNameFilter: BareNameFilter, key: Uint8Array): Promise<PrivateFile>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- mmpt: default
- bareNameFilter: BareNameFilter
- key: Uint8Array
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:112

`Static` fromInfo

fromInfo(crypto: Crypto.Implementation, depot: Depot.Implementation, mmpt: default, key: Uint8Array, info: Maybe<DecryptedNode>): Promise<PrivateFile>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- mmpt: default
- key: Uint8Array
- info: Maybe<DecryptedNode>
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:145

`Static` fromLatestName

fromLatestName(crypto: Crypto.Implementation, depot: Depot.Implementation, mmpt: default, name: PrivateName, key: Uint8Array): Promise<PrivateFile>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- mmpt: default
- name: PrivateName
- key: Uint8Array
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:123

`Static` fromName

fromName(crypto: Crypto.Implementation, depot: Depot.Implementation, mmpt: default, name: PrivateName, key: Uint8Array): Promise<PrivateFile>
Parameters
- crypto: Crypto.Implementation
- depot: Depot.Implementation
- mmpt: default
- name: PrivateName
- key: Uint8Array
Returns Promise<PrivateFile>
- Defined in fs/v1/PrivateFile.ts:134

`Static` instanceOf

instanceOf(obj: unknown): obj is PrivateFile
Parameters
- obj: unknown
Returns obj is PrivateFile
- Defined in fs/v1/PrivateFile.ts:71

Generated using TypeDoc