Class Share

ls

exists

• exists(path?): Promise<boolean>

• Parameters

  • Optional path: Segments

  Returns Promise<boolean>

listDirectory

• listDirectory(path, listOptions): Promise<DirectoryItemWithKind[]>

• Parameters

  • path: Segments
  • listOptions: {
        withItemKind: true;
    }

    • withItemKind: true

  Returns Promise<DirectoryItemWithKind[]>

• listDirectory(path, listOptions): Promise<DirectoryItem[]>

• Parameters

  • path: Segments
  • listOptions: {
        withItemKind: false;
    }

    • withItemKind: false

  Returns Promise<DirectoryItem[]>

• listDirectory(): Promise<DirectoryItem[]>

• Returns Promise<DirectoryItem[]>

• listDirectory(path): Promise<DirectoryItem[]>

• Parameters

  • path: Segments

  Returns Promise<DirectoryItem[]>

• listDirectory(path?, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>

• Parameters

  • Optional path: Segments
  • Optional listOptions: {
        withItemKind: boolean;
    }

    • withItemKind: boolean

  Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

read

• read<D, V>(dataType, path?, options?): Promise<DataForType<D, V>>

• Type Parameters

  • D extends DataType
  • V = unknown

  Parameters

  • dataType: D
  • Optional path: Segments
  • Optional options: {
        length?: number;
        offset?: number;
    }

    • Optional length?: number

    • Optional offset?: number

  Returns Promise<DataForType<D, V>>

size

• size(path?): Promise<number>

• Parameters

  • Optional path: Segments

  Returns Promise<number>

export

• export(): PrivateNode

• Returns PrivateNode

Readonly id