Class PrivateFile

A file in a WNFS public file system.

Constructors

constructor

Methods

asNode free getContent getId getSize metadata readAt store withContent

Constructors

constructor

  • new PrivateFile(parent_bare_name, time, rng): PrivateFile

  • Creates an empty private file.

    Parameters

    • parent_bare_name: Name
    • time: Date
    • rng: Rng

    Returns PrivateFile

Methods

asNode

  • asNode(): PrivateNode

  • Converts this file to a node.

    Returns PrivateNode

free

  • free(): void

  • Returns void

getContent

  • getContent(forest, 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

getSize

  • getSize(forest, 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

readAt

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

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

    Parameters

    Returns Promise<any>

store

  • store(forest, store, rng): Promise<any>

  • Persists the current state of this file in the BlockStore and PrivateForest. This will also force a history entry to be created, if there were changes.

    Parameters

    Returns Promise<any>

Static withContent

  • withContent(parent_bare_name, time, content, forest, store, rng): Promise<any>

  • Creates a file with provided content.

    Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorasNodefreegetContentgetIdgetSizemetadatareadAtstorewithContent

Generated using TypeDoc