Class PublicDirectory

A directory in a WNFS public file system.

Constructors

constructor

Methods

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

Constructors

constructor

  • new PublicDirectory(time): PublicDirectory

  • Creates a new directory using the given metadata.

    Parameters

    • time: Date

    Returns PublicDirectory

Methods

asNode

  • asNode(): PublicNode

  • Converts directory to a node.

    Returns PublicNode

basicMv

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

  • Moves a specified path to a new location.

    Parameters

    • path_segments_from: any[]
    • path_segments_to: any[]
    • time: Date
    • store: BlockStore

    Returns Promise<any>

cp

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

  • Copies a specific node to another location.

    Parameters

    • path_segments_from: any[]
    • path_segments_to: any[]
    • time: Date
    • store: BlockStore

    Returns Promise<any>

free

  • free(): void

  • Returns void

getId

  • getId(): string

  • Gets a unique id for node.

    Returns string

getNode

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

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

    Parameters

    Returns Promise<any>

lookupNode

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

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

    Parameters

    Returns Promise<any>

ls

  • ls(path_segments, 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, time, store): 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>

previousCids

  • previousCids(): Uint8Array[]

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

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

    Returns Uint8Array[]

read

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

  • Reads specified file content from the directory.

    Parameters

    Returns Promise<any>

rm

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

  • Removes a file or directory from the directory.

    Parameters

    Returns Promise<any>

store

  • store(store): Promise<any>

  • Stores directory in provided block store.

    Parameters

    Returns Promise<any>

write

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

  • Writes a file to the directory.

    Parameters

    • path_segments: any[]
    • content: Uint8Array
    • time: Date
    • store: BlockStore

    Returns Promise<any>

Static load

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

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

    Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorasNodebasicMvcpfreegetIdgetNodelookupNodelsmetadatamkdirpreviousCidsreadrmstorewriteload

Generated using TypeDoc