Class PublicFile

A file in a WNFS public file system.

Constructors

constructor

Methods

asNode free getContent getId getRawContentCid getSize metadata previousCids readAt setContent store load

Constructors

constructor

  • new PublicFile(time): PublicFile

  • Creates a new file in a WNFS public file system.

    Parameters

    • time: Date

    Returns PublicFile

Methods

asNode

  • asNode(): PublicNode

  • Converts this directory to a node.

    Returns PublicNode

free

  • free(): void

  • Returns void

getContent

  • getContent(store): Promise<any>

  • Gets the entire content of a file.

    Parameters

    Returns Promise<any>

getId

  • getId(): string

  • Gets a unique id for node.

    Returns string

getRawContentCid

  • getRawContentCid(store): Promise<any>

  • Gets the content cid of the file.

    Parameters

    Returns Promise<any>

getSize

  • getSize(store): Promise<any>

  • Gets the exact content size without fetching all content blocks.

    Parameters

    Returns Promise<any>

metadata

  • metadata(): any

  • Gets the metadata of this file.

    Returns any

previousCids

  • previousCids(): Uint8Array[]

  • Gets the previous CID(s) of the file. This will usually be an array of a single CID, but may be

    • an empty array, if this is the first revision of a file
    • an array with multiple elements if this is the merge node of multiple concurrent changes to the file.

    Returns Uint8Array[]

readAt

  • readAt(byte_offset, limit, store): Promise<any>

  • Gets the content of the file at given offset & with an optional byte limit.

    Parameters

    • byte_offset: number
    • limit: undefined | number
    • store: BlockStore

    Returns Promise<any>

setContent

  • setContent(time, content, store): Promise<any>

  • Sets the content of a file to a byte array.

    Parameters

    Returns Promise<any>

store

  • store(store): Promise<any>

  • Stores a file in provided block store.

    Parameters

    Returns Promise<any>

Static load

  • load(cid, store): Promise<any>

  • Loads a file given its CID from the block store.

    Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorasNodefreegetContentgetIdgetRawContentCidgetSizemetadatapreviousCidsreadAtsetContentstoreload

Generated using TypeDoc