Class FS

constructor

• new FS(params: FSConfig): FS

  Parameters

  • params: FSConfig

  Returns FS

_items

_uuidToItem

_addItem

• _addItem(param0: { item: FSItem; path: string }): Promise<void>

  Add an item to the internal item tree.

  Parameters

  • param0: { item: FSItem; path: string }

  Returns Promise<void>

  Async

_removeItem

• _removeItem(param0: { path: string }): Promise<void>

  Remove an item from the internal item tree.

  Parameters

  • param0: { path: string }

  Returns Promise<void>

  Async

copy

• copy(
      ...params: [
          {
              abortSignal?: AbortSignal;
              from: string;
              onProgress?: ProgressCallback;
              onProgressId?: string;
              pauseSignal?: PauseSignal;
              to: string;
          },
      ],
  ): Promise<void>

  Alias of cp.

  Parameters

  • ...params: [
        {
            abortSignal?: AbortSignal;
            from: string;
            onProgress?: ProgressCallback;
            onProgressId?: string;
            pauseSignal?: PauseSignal;
            to: string;
        },
    ]

  Returns Promise<void>

  Date

  2/14/2024 - 5:07:27 AM

  Async

cp

• cp(
      param0: {
          abortSignal?: AbortSignal;
          from: string;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          pauseSignal?: PauseSignal;
          to: string;
      },
  ): Promise<void>

  Copy a file or directory structure. Recursively creates intermediate directories if needed. Warning: Can be really inefficient when copying large directory structures. All files need to be downloaded first and then reuploaded due to our end to end encryption. Plain copying unfortunately does not work. Only available in a Node.JS environment.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        from: string;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        pauseSignal?: PauseSignal;
        to: string;
    }

  Returns Promise<void>

  Async

download

• download(
      param0: {
          abortSignal?: AbortSignal;
          destination: string;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          path: string;
          pauseSignal?: PauseSignal;
      },
  ): Promise<void>

  Download a file or directory from path to a local destination path. Only available in a Node.JS environment.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        destination: string;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        path: string;
        pauseSignal?: PauseSignal;
    }

  Returns Promise<void>

  Async

ls

• ls(...params: [{ path: string; recursive?: boolean }]): Promise<string[]>

  Alias of readdir.

  Parameters

  • ...params: [{ path: string; recursive?: boolean }]

  Returns Promise<string[]>

  Date

  2/13/2024 - 8:48:40 PM

  Async

lstat

• lstat(...params: [{ path: string }]): Promise<FSStats>

  Alias of stat.

  Parameters

  • ...params: [{ path: string }]

  Returns Promise<FSStats>

  Date

  2/13/2024 - 8:49:18 PM

  Async

mkdir

• mkdir(param0: { path: string }): Promise<string>

  Creates a directory at path. Recursively creates intermediate directories if they don't exist.

  Parameters

  • param0: { path: string }

  Returns Promise<string>

  Date

  2/14/2024 - 1:34:11 AM

  Async

pathToItemUUID

• pathToItemUUID(
      __namedParameters: { path: string; type?: FSItemType },
  ): Promise<null | string>

  Parameters

  • __namedParameters: { path: string; type?: FSItemType }

  Returns Promise<null | string>

read

• read(
      param0: {
          abortSignal?: AbortSignal;
          length?: number;
          offset?: number;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          path: string;
          pauseSignal?: PauseSignal;
          position?: number;
      },
  ): Promise<Buffer>

  Read a file. Returns buffer of given length, at position and offset. Memory efficient to read only a small part of a file.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        length?: number;
        offset?: number;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        path: string;
        pauseSignal?: PauseSignal;
        position?: number;
    }

  Returns Promise<Buffer>

  Async

readdir

• readdir(param0: { path: string; recursive?: boolean }): Promise<string[]>

  List files and directories at path.

  Parameters

  • param0: { path: string; recursive?: boolean }

  Returns Promise<string[]>

  Date

  2/20/2024 - 2:40:03 AM

  Async

readFile

• readFile(
      param0: {
          abortSignal?: AbortSignal;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          path: string;
          pauseSignal?: PauseSignal;
      },
  ): Promise<Buffer>

  Read a file at path. Warning: This reads the whole file into memory and can be pretty inefficient.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        path: string;
        pauseSignal?: PauseSignal;
    }

  Returns Promise<Buffer>

  Async

rename

• rename(param0: { from: string; to: string }): Promise<void>

  Rename or move a file/directory. Recursively creates intermediate directories if needed.

  Parameters

  • param0: { from: string; to: string }

  Returns Promise<void>

  Date

  2/14/2024 - 1:39:32 AM

  Async

rm

• rm(param0: { path: string; permanent?: boolean }): Promise<void>

  Alias of unlink.

  Parameters

  • param0: { path: string; permanent?: boolean }

  Returns Promise<void>

  Date

  2/28/2024 - 4:58:30 PM

  Async

rmdir

• rmdir(...params: [{ path: string; permanent?: boolean }]): Promise<void>

  Deletes directory at path.

  Parameters

  • ...params: [{ path: string; permanent?: boolean }]

  Returns Promise<void>

  Date

  2/14/2024 - 2:53:48 AM

  Async

rmfile

• rmfile(...params: [{ path: string; permanent?: boolean }]): Promise<void>

  Deletes a file at path.

  Parameters

  • ...params: [{ path: string; permanent?: boolean }]

  Returns Promise<void>

  Async

stat

• stat(__namedParameters: { path: string }): Promise<FSStats>

  Parameters

  • __namedParameters: { path: string }

  Returns Promise<FSStats>

statfs

• statfs(): Promise<StatFS>

  Returns filesystem information.

  Returns Promise<StatFS>

  Date

  2/14/2024 - 2:13:19 AM

  Async

unlink

• unlink(param0: { path: string; permanent?: boolean }): Promise<void>

  Deletes file/directory at path.

  Parameters

  • param0: { path: string; permanent?: boolean }

  Returns Promise<void>

  Date

  2/28/2024 - 4:58:37 PM

  Async

upload

• upload(
      param0: {
          abortSignal?: AbortSignal;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          overwriteDirectory?: boolean;
          path: string;
          pauseSignal?: PauseSignal;
          source: string;
      },
  ): Promise<CloudItem>

  Upload file or directory to path from a local source path. Recursively creates intermediate directories if needed. Only available in a Node.JS environment.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        overwriteDirectory?: boolean;
        path: string;
        pauseSignal?: PauseSignal;
        source: string;
    }

  Returns Promise<CloudItem>

  Async

write

• write(
      ...params: [
          {
              abortSignal?: AbortSignal;
              content: Buffer;
              encryptionKey?: string;
              onProgress?: ProgressCallback;
              onProgressId?: string;
              path: string;
              pauseSignal?: PauseSignal;
          },
      ],
  ): Promise<CloudItem>

  Alias of writeFile.

  Parameters

  • ...params: [
        {
            abortSignal?: AbortSignal;
            content: Buffer;
            encryptionKey?: string;
            onProgress?: ProgressCallback;
            onProgressId?: string;
            path: string;
            pauseSignal?: PauseSignal;
        },
    ]

  Returns Promise<CloudItem>

  Date

  2/20/2024 - 9:45:40 PM

  Async

writeFile

• writeFile(
      param0: {
          abortSignal?: AbortSignal;
          content: Buffer;
          encryptionKey?: string;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          path: string;
          pauseSignal?: PauseSignal;
      },
  ): Promise<CloudItem>

  Write to a file. Warning: This reads the whole file into memory and can be very inefficient. Only available in a Node.JS environment.

  Parameters

  • param0: {
        abortSignal?: AbortSignal;
        content: Buffer;
        encryptionKey?: string;
        onProgress?: ProgressCallback;
        onProgressId?: string;
        path: string;
        pauseSignal?: PauseSignal;
    }

  Returns Promise<CloudItem>

  Async