Class PublicFile

Hierarchy

BaseFile
- PublicFile

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PublicFile(__namedParameters: <internal>.ConstructorParams): PublicFile

Overrides BaseFile.constructor
- Defined in fs/v1/PublicFile.ts:28
Parameters
- __namedParameters: <internal>.ConstructorParams
Returns PublicFile

Properties

cid

cid: Maybe<CID>

content

content: FileContent

header

header: FileHeader

history

history: <internal>.default

readOnly

readOnly: boolean

Methods

put

put(): Promise<CID>

Inherited from BaseFile.put
- Defined in fs/base/file.ts:18
Returns Promise<CID>

putDetailed

putDetailed(): Promise<PutDetails>

Overrides BaseFile.putDetailed
- Defined in fs/v1/PublicFile.ts:65
Returns Promise<PutDetails>

updateContent

updateContent(content: FileContent): Promise<PublicFile>

Inherited from BaseFile.updateContent
- Defined in fs/base/file.ts:23
Parameters
- content: FileContent
Returns Promise<PublicFile>

Static create

create(content: FileContent): Promise<PublicFile>

- Defined in fs/v1/PublicFile.ts:42
Parameters
- content: FileContent
Returns Promise<PublicFile>

Static fromCID

fromCID(cid: CID): Promise<PublicFile>

- Defined in fs/v1/PublicFile.ts:50
Parameters
- cid: CID
Returns Promise<PublicFile>

Static fromInfo

fromInfo(info: FileInfo, cid: CID): Promise<PublicFile>

- Defined in fs/v1/PublicFile.ts:55
Parameters
- info: FileInfo
- cid: CID
Returns Promise<PublicFile>

Static instanceOf

instanceOf(obj: unknown): obj is PublicFile

- Defined in fs/v1/PublicFile.ts:36
Parameters
- obj: unknown
Returns obj is PublicFile

Generated using TypeDoc