Class PrivateDirectory

A directory in a WNFS public file system.

Constructors

constructor

Methods

asNode basicMv cp free getId getNode lookupNode ls metadata mkdir read rm store write newAndStore

Constructors

constructor

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

  • Creates a new private directory.

    Parameters

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

    Returns PrivateDirectory

Methods

asNode

  • asNode(): PrivateNode

  • Converts directory to a node.

    Returns PrivateNode

basicMv

  • basicMv(path_segments_from, path_segments_to, search_latest, time, forest, store, rng): Promise<any>

  • Moves a specified path to a new location.

    Parameters

    • path_segments_from: any[]
    • path_segments_to: any[]
    • search_latest: boolean
    • time: Date
    • forest: PrivateForest
    • store: BlockStore
    • rng: Rng

    Returns Promise<any>

cp

  • cp(path_segments_from, path_segments_to, search_latest, time, forest, store, rng): Promise<any>

  • Copies a specified path to a new location.

    Parameters

    • path_segments_from: any[]
    • path_segments_to: any[]
    • search_latest: boolean
    • time: Date
    • forest: PrivateForest
    • store: BlockStore
    • rng: Rng

    Returns Promise<any>

free

  • free(): void

  • Returns void

getId

  • getId(): string

  • Gets a unique id for node.

    Returns string

getNode

  • getNode(path_segments, search_latest, forest, store): Promise<any>

  • Follows a path and fetches the node at the end of the path.

    Parameters

    Returns Promise<any>

lookupNode

  • lookupNode(path_segment, search_latest, forest, store): Promise<any>

  • Looks up a node by its path name in the current directory.

    Parameters

    Returns Promise<any>

ls

  • ls(path_segments, search_latest, forest, store): Promise<any>

  • Returns names and metadata of the direct children of a directory.

    Parameters

    Returns Promise<any>

metadata

  • metadata(): any

  • Gets the metadata of the directory

    Returns any

mkdir

  • mkdir(path_segments, search_latest, time, forest, store, rng): Promise<any>

  • Creates a new directory at the specified path.

    This method acts like mkdir -p in Unix because it creates intermediate directories if they do not exist.

    Parameters

    Returns Promise<any>

read

  • read(path_segments, search_latest, forest, store): Promise<any>

  • Reads specified file content from the directory.

    Parameters

    Returns Promise<any>

rm

  • rm(path_segments, search_latest, forest, store): Promise<any>

  • Removes a file or directory from the directory.

    Parameters

    Returns Promise<any>

store

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

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

    Parameters

    Returns Promise<any>

write

  • write(path_segments, search_latest, content, time, forest, store, rng): Promise<any>

  • Writes a file to the directory.

    Parameters

    • path_segments: any[]
    • search_latest: boolean
    • content: Uint8Array
    • time: Date
    • forest: PrivateForest
    • store: BlockStore
    • rng: Rng

    Returns Promise<any>

Static newAndStore

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

  • This contstructor creates a new private directory and stores it in a provided PrivateForest.

    Parameters

    Returns Promise<Promise<any>>

Settings

Member Visibility

Theme

On This Page

constructorasNodebasicMvcpfreegetIdgetNodelookupNodelsmetadatamkdirreadrmstorewritenewAndStore

Generated using TypeDoc