Class Cloud

Cloud

Date

2/14/2024 - 11:29:58 PM

Export

Index

Constructors

constructor

new Cloud(params): Cloud
Creates an instance of Cloud.
Parameters
- params: CloudConfig
Returns Cloud
Date
2/14/2024 - 11:30:03 PM
- Defined in src/cloud/index.ts:198

Properties

`Private` `Readonly` _semaphores

_semaphores: {
    createDirectory: ISemaphore;
    directoryDownloads: ISemaphore;
    directoryUploads: ISemaphore;
    downloadStream: ISemaphore;
    downloadToLocal: ISemaphore;
    share: ISemaphore;
    uploads: ISemaphore;
} = ...

Type declaration

createDirectory: ISemaphore
directoryDownloads: ISemaphore
directoryUploads: ISemaphore
downloadStream: ISemaphore
downloadToLocal: ISemaphore
share: ISemaphore
uploads: ISemaphore

`Private` `Readonly` api

api: API

`Private` `Readonly` sdk

sdk: FilenSDK

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

`Readonly` utils

utils: {
    signals: {
        PauseSignal: typeof PauseSignal;
    };
    utils: {
        calculateChunkIndices: ((param0) => [number, number]);
        readLocalFileChunk: ((param0) => Promise<Buffer>);
        readWebFileChunk: ((param0) => Promise<Buffer>);
    };
} = ...

Type declaration

signals: {
PauseSignal: typeof PauseSignal;
}
- PauseSignal: typeof PauseSignal
utils: {
    calculateChunkIndices: ((param0) => [number, number]);
    readLocalFileChunk: ((param0) => Promise<Buffer>);
    readWebFileChunk: ((param0) => Promise<Buffer>);
}
- calculateChunkIndices: ((param0) => [number, number])
  - - (param0): [number, number]
    - Calculate the first and the last chunk of a file to fetch between startBytes and endBytes.
      Parameters
      param0: {
          chunks: number;
          end: number;
          start: number;
      }
      chunks: number
      end: number
      start: number
      Returns [number, number]
      Date
      3/18/2024 - 1:19:27 AM
      
      Export
- readLocalFileChunk: ((param0) => Promise<Buffer>)
  - - (param0): Promise<Buffer>
    - Reads a chunk from a local file.
      Parameters
      param0: {
          length: number;
          offset: number;
          path: string;
      }
      length: number
      offset: number
      path: string
      Returns Promise<Buffer>
      Date
      2/16/2024 - 5:45:19 AM
      
      Export
- readWebFileChunk: ((param0) => Promise<Buffer>)
  - - (param0): Promise<Buffer>
    - Reads a chunk from a web-based file, such as from an field.
      Parameters
      param0: {
          file: File;
          index: number;
          length: number;
      }
      file: File
      index: number
      length: number
      Returns Promise<Buffer>
      Date
      2/16/2024 - 5:45:27 AM
      
      Export

Methods

`Private` addItemToDirectoryPublicLink

addItemToDirectoryPublicLink(param0): Promise<void>
Private
Add an item to a directory public link.
Parameters
- param0: {
      expiration: PublicLinkExpiration;
      linkKeyEncrypted: string;
      linkUUID: string;
      metadata: FileMetadata | FolderMetadata;
      parent: string;
      type: "file" | "folder";
      uuid: string;
  }
  - expiration: PublicLinkExpiration
  - linkKeyEncrypted: string
  - linkUUID: string
  - metadata: FileMetadata | FolderMetadata
  - parent: string
  - type: "file" | "folder"
  - uuid: string
Returns Promise<void>
Date
2/19/2024 - 5:08:51 AM

Async
- Defined in src/cloud/index.ts:1495

changeDirectoryColor

changeDirectoryColor(param0): Promise<void>
Change the color of a directory.
Parameters
- param0: {
  color: string;
  uuid: string;
  }
  - color: string
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 8:52:40 PM

Async
- Defined in src/cloud/index.ts:1282

checkIfItemIsSharedForRename

checkIfItemIsSharedForRename(param0): Promise<void>
Checks if an item is shared or public linked. If so, it renames the item.
Parameters
- param0: {
  itemMetadata: FileMetadata | FolderMetadata;
  uuid: string;
  }
  - itemMetadata: FileMetadata | FolderMetadata
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 4:37:30 AM

Async
- Defined in src/cloud/index.ts:2514

checkIfItemParentIsShared

checkIfItemParentIsShared(param0): Promise<void>
Checks if the parent of an item is shared or public linked. If so, it adds the item and all children of the item (in case of a directory) to the share or public link.
Parameters
- param0: {
      itemMetadata: FileMetadata | FolderMetadata;
      parent: string;
      type: "file" | "directory";
      uuid: string;
  }
  - itemMetadata: FileMetadata | FolderMetadata
  - parent: string
  - type: "file" | "directory"
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 4:26:44 AM

Async
- Defined in src/cloud/index.ts:2216

createDirectory

createDirectory(param0): Promise<string>
Create a directory under parent.
Parameters
- param0: {
      name: string;
      parent: string;
      renameIfExists?: boolean;
      uuid?: string;
  }
  - name: string
  - parent: string
  - Optional renameIfExists?: boolean
  - Optional uuid?: string
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:1220

deleteDirectory

deleteDirectory(param0): Promise<void>
Permanently delete a directory.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 11:42:13 PM

Async
- Defined in src/cloud/index.ts:1340

deleteFile

deleteFile(param0): Promise<void>
Permanently delete a file.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 11:42:05 PM

Async
- Defined in src/cloud/index.ts:1326

directoryExists

directoryExists(param0): Promise<DirExistsResponse>
Check if a directory with exists in parent.
Parameters
- param0: {
  name: string;
  parent: string;
  }
  - name: string
  - parent: string
Returns Promise<DirExistsResponse>
Async
- Defined in src/cloud/index.ts:848

directoryPublicLinkContent

directoryPublicLinkContent(param0): Promise<DirLinkContentDecryptedResponse>
Fetch contents of a directory public link or it's children.
Parameters
- param0: {
      key: string;
      parent: string;
      password?: string;
      salt?: string;
      uuid: string;
  }
  - key: string
  - parent: string
  - Optional password?: string
  - Optional salt?: string
  - uuid: string
Returns Promise<DirLinkContentDecryptedResponse>
Async
- Defined in src/cloud/index.ts:1937

directoryPublicLinkInfo

directoryPublicLinkInfo(param0): Promise<DirLinkInfoDecryptedResponse>
Fetch info about a directory public link.
Parameters
- param0: {
  key: string;
  uuid: string;
  }
  - key: string
  - uuid: string
Returns Promise<DirLinkInfoDecryptedResponse>
Async
- Defined in src/cloud/index.ts:1899

directorySize

directorySize(param0): Promise<{
    files: number;
    folders: number;
    size: number;
}>
Fetch directory size in bytes, including file and folder count.
Parameters
- param0: {
      receiverId?: number;
      sharerId?: number;
      trash?: boolean;
      uuid: string;
  }
  - Optional receiverId?: number
  - Optional sharerId?: number
  - Optional trash?: boolean
  - uuid: string
Returns Promise<{
    files: number;
    folders: number;
    size: number;
}>
Date
2/20/2024 - 9:21:16 PM

Async
- Defined in src/cloud/index.ts:2576

directorySizePublicLink

directorySizePublicLink(param0): Promise<{
    files: number;
    folders: number;
    size: number;
}>
Fetch size of a directory inside a public link in bytes, including file and folder count.
Parameters
- param0: {
  linkUUID: string;
  uuid: string;
  }
  - linkUUID: string
  - uuid: string
Returns Promise<{
    files: number;
    folders: number;
    size: number;
}>
Date
2/20/2024 - 9:21:53 PM

Async
- Defined in src/cloud/index.ts:2606

directoryUUIDToPath

directoryUUIDToPath(param0): Promise<string>
Recursively find the full path of a file using it's UUID.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:4873

disablePublicLink

disablePublicLink(param0): Promise<void>
Disable a file/directory public link.
Parameters
- param0: {
  itemUUID: string;
  type: "directory";
  }
  - itemUUID: string
  - type: "directory"
Returns Promise<void>
Date
2/19/2024 - 4:47:27 AM

Async
- Defined in src/cloud/index.ts:1720
disablePublicLink(param0): Promise<void>
Disable a file/directory public link.
Parameters
- param0: {
      itemUUID: string;
      linkUUID: string;
      type: "file";
  }
  - itemUUID: string
  - linkUUID: string
  - type: "file"
Returns Promise<void>
Date
2/19/2024 - 4:47:27 AM

Async
- Defined in src/cloud/index.ts:1721

downloadDirectoryToLocal

downloadDirectoryToLocal(param0): Promise<string>
Download a directory to path. Only available in a Node.JS environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      linkHasPassword?: boolean;
      linkKey?: string;
      linkPassword?: string;
      linkSalt?: string;
      linkUUID?: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      pauseSignal?: PauseSignal;
      to?: string;
      type?: DirDownloadType;
      uuid: string;
  }
  - Optional abortSignal?: AbortSignal
  - Optional linkHasPassword?: boolean
  - Optional linkKey?: string
  - Optional linkPassword?: string
  - Optional linkSalt?: string
  - Optional linkUUID?: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional pauseSignal?: PauseSignal
  - Optional to?: string
  - Optional type?: DirDownloadType
  - uuid: string
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:3403

downloadFileToLocal

downloadFileToLocal(param0): Promise<string>
Download a file to a local path. Only works in a Node.JS environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunks: number;
      end?: number;
      key: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      pauseSignal?: PauseSignal;
      region: string;
      size: number;
      start?: number;
      to?: string;
      uuid: string;
      version: FileEncryptionVersion;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunks: number
  - Optional end?: number
  - key: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional pauseSignal?: PauseSignal
  - region: string
  - size: number
  - Optional start?: number
  - Optional to?: string
  - uuid: string
  - version: FileEncryptionVersion
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:2664

downloadFileToReadableStream

downloadFileToReadableStream(param0): ReadableStream<Buffer>
Download a file to a ReadableStream.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      bucket: string;
      chunks: number;
      end?: number;
      key: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      pauseSignal?: PauseSignal;
      region: string;
      size: number;
      start?: number;
      uuid: string;
      version: FileEncryptionVersion;
  }
  - Optional abortSignal?: AbortSignal
  - bucket: string
  - chunks: number
  - Optional end?: number
  - key: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional pauseSignal?: PauseSignal
  - region: string
  - size: number
  - Optional start?: number
  - uuid: string
  - version: FileEncryptionVersion
Returns ReadableStream<Buffer>
- Defined in src/cloud/index.ts:2803

editFileMetadata

editFileMetadata(param0): Promise<void>
Edit metadata of a file (currently uses the rename endpoint, might change later).
Parameters
- param0: {
  metadata: FileMetadata;
  uuid: string;
  }
  - metadata: FileMetadata
  - uuid: string
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:868

editPublicLink

editPublicLink(param0): Promise<void>
Edit a file/directory public link.
Parameters
- param0: {
      enableDownload?: boolean;
      expiration: PublicLinkExpiration;
      itemUUID: string;
      linkUUID?: string;
      password?: string;
      type: "file" | "directory";
  }
  - Optional enableDownload?: boolean
  - expiration: PublicLinkExpiration
  - itemUUID: string
  - Optional linkUUID?: string
  - Optional password?: string
  - type: "file" | "directory"
Returns Promise<void>
Date
2/19/2024 - 4:57:03 AM

Async
- Defined in src/cloud/index.ts:1665

emptyTrash

emptyTrash(): Promise<void>
Empty the trash.

Returns Promise<void>
Async
- Defined in src/cloud/index.ts:4831

enablePublicLink

enablePublicLink(param0): Promise<string>
Enable a public link for a file or a directory.
Parameters
- param0: {
      onProgress?: ProgressWithTotalCallback;
      type: "file" | "directory";
      uuid: string;
  }
  - Optional onProgress?: ProgressWithTotalCallback
  - type: "file" | "directory"
  - uuid: string
Returns Promise<string>
Date
2/19/2024 - 5:13:57 AM

Async
- Defined in src/cloud/index.ts:1556

favoriteDirectory

favoriteDirectory(param0): Promise<void>
Toggle the favorite status of a directory.
Parameters
- param0: {
  favorite: boolean;
  uuid: string;
  }
  - favorite: boolean
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 8:54:03 PM

Async
- Defined in src/cloud/index.ts:1297

favoriteFile

favoriteFile(param0): Promise<void>
Toggle the favorite status of a file.
Parameters
- param0: {
  favorite: boolean;
  uuid: string;
  }
  - favorite: boolean
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 8:54:23 PM

Async
- Defined in src/cloud/index.ts:1312

fileExists

fileExists(param0): Promise<FileExistsResponse>
Check if a file with exists in parent.
Parameters
- param0: {
  name: string;
  parent: string;
  }
  - name: string
  - parent: string
Returns Promise<FileExistsResponse>
Async
- Defined in src/cloud/index.ts:828

filePublicLinkHasPassword

filePublicLinkHasPassword(param0): Promise<FileLinkPasswordResponse>
Fetch password info of a public link.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<FileLinkPasswordResponse>
Async
- Defined in src/cloud/index.ts:1810

filePublicLinkInfo

filePublicLinkInfo(param0): Promise<Omit<FileLinkInfoResponse, "size"> & {
size: number;
}>
Fetch info of a file public link.
Parameters
- param0: {
      key: string;
      password?: string;
      salt?: string;
      uuid: string;
  }
  - key: string
  - Optional password?: string
  - Optional salt?: string
  - uuid: string
Returns Promise<Omit<FileLinkInfoResponse, "size"> & {
size: number;
}>
Async
- Defined in src/cloud/index.ts:1831

fileUUIDToPath

fileUUIDToPath(param0): Promise<string>
Recursively find the full path of a file using it's UUID.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:4844

fileVersions

fileVersions(param0): Promise<FileVersionsResponse>
Retrieve all versions of a file.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<FileVersionsResponse>
Date
2/15/2024 - 11:46:38 PM

Async
- Defined in src/cloud/index.ts:1410

getDirectory

getDirectory(param0): Promise<GetDirResult>
Get info about a directory and decrypt its metadata.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<GetDirResult>
Async
- Defined in src/cloud/index.ts:4922

getDirectoryTree

getDirectoryTree(param0): Promise<Record<string, CloudItemTree>>
Build a recursive directory tree which includes sub-directories and sub-files.
Parameters
- param0: {
      linkHasPassword?: boolean;
      linkKey?: string;
      linkPassword?: string;
      linkSalt?: string;
      linkUUID?: string;
      skipCache?: boolean;
      type?: DirDownloadType;
      uuid: string;
  }
  - Optional linkHasPassword?: boolean
  - Optional linkKey?: string
  - Optional linkPassword?: string
  - Optional linkSalt?: string
  - Optional linkUUID?: string
  - Optional skipCache?: boolean
  - Optional type?: DirDownloadType
  - uuid: string
Returns Promise<Record<string, CloudItemTree>>
Date
2/22/2024 - 1:45:28 AM

Async
- Defined in src/cloud/index.ts:3222

getFile

getFile(param0): Promise<GetFileResult>
Get info about a file and decrypt its metadata.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<GetFileResult>
Async
- Defined in src/cloud/index.ts:4902

listDirectory

listDirectory(param0): Promise<CloudItem[]>
Lists all files and directories in a directory.
Parameters
- param0: {
  onlyDirectories?: boolean;
  uuid: string;
  }
  - Optional onlyDirectories?: boolean
  - uuid: string
Returns Promise<CloudItem[]>
Date
3/14/2024 - 5:21:55 AM

Async
- Defined in src/cloud/index.ts:222

listDirectorySharedIn

listDirectorySharedIn(param0): Promise<CloudItemShared[]>
List shared in files and directories based on parent.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<CloudItemShared[]>
Date
2/15/2024 - 1:16:49 AM

Async
- Defined in src/cloud/index.ts:307

listDirectorySharedOut

listDirectorySharedOut(param0): Promise<CloudItemShared[]>
List shared out files and directories based on parent.
Parameters
- param0: {
  receiverId?: number;
  uuid: string;
  }
  - Optional receiverId?: number
  - uuid: string
Returns Promise<CloudItemShared[]>
Date
2/15/2024 - 1:16:32 AM

Async
- Defined in src/cloud/index.ts:400

listFavorites

listFavorites(): Promise<CloudItem[]>
List all favorite files and directories.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 8:59:52 PM

Async
- Defined in src/cloud/index.ts:660

listPublicLinks

listPublicLinks(): Promise<CloudItem[]>
List all public linked files and directories.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 9:01:01 PM

Async
- Defined in src/cloud/index.ts:743

listRecents

listRecents(): Promise<CloudItem[]>
List all recently uploaded files.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 1:16:20 AM

Async
- Defined in src/cloud/index.ts:522

listTrash

listTrash(): Promise<CloudItem[]>
List all files and directories inside the trash.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 8:59:04 PM

Async
- Defined in src/cloud/index.ts:577

moveDirectory

moveDirectory(param0): Promise<void>
Move a directory.
Parameters
- param0: {
      metadata: FolderMetadata;
      overwriteIfExists?: boolean;
      to: string;
      uuid: string;
  }
  - metadata: FolderMetadata
  - Optional overwriteIfExists?: boolean
  - to: string
  - uuid: string
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1136

moveFile

moveFile(param0): Promise<void>
Move a file.
Parameters
- param0: {
      metadata: FileMetadata;
      overwriteIfExists?: boolean;
      to: string;
      uuid: string;
  }
  - metadata: FileMetadata
  - Optional overwriteIfExists?: boolean
  - to: string
  - uuid: string
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1080

publicLinkStatus

publicLinkStatus(param0): Promise<FileLinkStatusResponse>
Fetch the status of a public link.
Parameters
- param0: {
  type: "file";
  uuid: string;
  }
  - type: "file"
  - uuid: string
Returns Promise<FileLinkStatusResponse>
Async
- Defined in src/cloud/index.ts:1774
publicLinkStatus(param0): Promise<DirLinkStatusResponse>
Fetch the status of a public link.
Parameters
- param0: {
  type: "directory";
  uuid: string;
  }
  - type: "directory"
  - uuid: string
Returns Promise<DirLinkStatusResponse>
Async
- Defined in src/cloud/index.ts:1775

removeSharedItem

removeSharedItem(param0): Promise<void>
Stop receiving a shared item.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/19/2024 - 4:38:36 AM

Async
- Defined in src/cloud/index.ts:2060

renameDirectory

renameDirectory(param0): Promise<void>
Rename a directory.
Parameters
- param0: {
      name: string;
      overwriteIfExists?: boolean;
      uuid: string;
  }
  - name: string
  - Optional overwriteIfExists?: boolean
  - uuid: string
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1003

renameFile

renameFile(param0): Promise<void>
Rename a file.
Parameters
- param0: {
      metadata: FileMetadata;
      name: string;
      overwriteIfExists?: boolean;
      uuid: string;
  }
  - metadata: FileMetadata
  - name: string
  - Optional overwriteIfExists?: boolean
  - uuid: string
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:918

`Private` renamePubliclyLinkedItem

renamePubliclyLinkedItem(param0): Promise<void>
Private
Rename a publicly linked item.
Parameters
- param0: {
      linkKeyEncrypted: string;
      linkUUID: string;
      metadata: FileMetadata | FolderMetadata;
      uuid: string;
  }
  - linkKeyEncrypted: string
  - linkUUID: string
  - metadata: FileMetadata | FolderMetadata
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 4:35:07 AM

Async
- Defined in src/cloud/index.ts:2468

`Private` renameSharedItem

renameSharedItem(param0): Promise<void>
Private
Rename a shared item.
Parameters
- param0: {
      metadata: FileMetadata | FolderMetadata;
      publicKey: string;
      receiverId: number;
      uuid: string;
  }
  - metadata: FileMetadata | FolderMetadata
  - publicKey: string
  - receiverId: number
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 4:32:56 AM

Async
- Defined in src/cloud/index.ts:2437

restoreDirectory

restoreDirectory(param0): Promise<void>
Restore a directory from the trash.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 11:43:29 PM

Async
- Defined in src/cloud/index.ts:1368

restoreFile

restoreFile(param0): Promise<void>
Restore a file from the trash.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 11:43:21 PM

Async
- Defined in src/cloud/index.ts:1354

restoreFileVersion

restoreFileVersion(param0): Promise<void>
Restore a file version.
Parameters
- param0: {
  currentUUID: string;
  uuid: string;
  }
  - currentUUID: string
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 11:44:51 PM

Async
- Defined in src/cloud/index.ts:1383

`Private` shareItem

shareItem(param0): Promise<void>
Private
Share an item to another Filen user.
Parameters
- param0: {
      email: string;
      metadata: FileMetadata | FolderMetadata;
      parent: string;
      publicKey: string;
      type: "file" | "folder";
      uuid: string;
  }
  - email: string
  - metadata: FileMetadata | FolderMetadata
  - parent: string
  - publicKey: string
  - type: "file" | "folder"
  - uuid: string
Returns Promise<void>
Date
2/17/2024 - 4:11:05 AM

Async
- Defined in src/cloud/index.ts:1436

shareItemsToUser

shareItemsToUser(param0): Promise<void>
Share a file or a directory (and all it's children) to a user.
Parameters
- param0: {
      directories: {
          metadata: FolderMetadata;
          parent: string;
          uuid: string;
      }[];
      email: string;
      files: {
          metadata: FileMetadata;
          parent: string;
          uuid: string;
      }[];
      onProgress?: ProgressWithTotalCallback;
  }
  - directories: {
        metadata: FolderMetadata;
        parent: string;
        uuid: string;
    }[]
  - email: string
  - files: {
        metadata: FileMetadata;
        parent: string;
        uuid: string;
    }[]
  - Optional onProgress?: ProgressWithTotalCallback
Returns Promise<void>
Date
2/19/2024 - 4:35:03 AM

Async
- Defined in src/cloud/index.ts:2082

stopSharingItem

stopSharingItem(param0): Promise<void>
Stop sharing an item with another user.
Parameters
- param0: {
  receiverId: number;
  uuid: string;
  }
  - receiverId: number
  - uuid: string
Returns Promise<void>
Date
2/19/2024 - 4:38:21 AM

Async
- Defined in src/cloud/index.ts:2046

trashDirectory

trashDirectory(param0): Promise<void>
Send a directory to the trash bin.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 2:07:13 AM

Async
- Defined in src/cloud/index.ts:1199

trashFile

trashFile(param0): Promise<void>
Send a file to the trash bin.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/15/2024 - 2:07:13 AM

Async
- Defined in src/cloud/index.ts:1185

uploadDirectoryFromWeb

uploadDirectoryFromWeb(param0): Promise<void>
Upload a web-based directory, such as from an field. Only works in a browser environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      files: {
          file: File;
          path: string;
      }[];
      name?: string;
      onDirectoryCreated?: ((item) => void);
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      onUploaded?: ((item) => Promise<void>);
      parent: string;
      pauseSignal?: PauseSignal;
      throwOnSingleFileUploadError?: boolean;
  }
  - Optional abortSignal?: AbortSignal
  - files: {
    file: File;
    path: string;
    }[]
  - Optional name?: string
  - Optional onDirectoryCreated?: ((item) => void)
    - (item): void
      Parameters
      item: CloudItem
      Returns void
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional onUploaded?: ((item) => Promise<void>)
    - (item): Promise<void>
      Parameters
      item: CloudItem
      Returns Promise<void>
  - parent: string
  - Optional pauseSignal?: PauseSignal
  - Optional throwOnSingleFileUploadError?: boolean
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:4647

uploadLocalDirectory

uploadLocalDirectory(param0): Promise<void>
Upload a local file at path. Only works in a Node.JS environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      name?: string;
      onDirectoryCreated?: ((item) => void);
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      onUploaded?: ((item) => Promise<void>);
      parent: string;
      pauseSignal?: PauseSignal;
      source: string;
      throwOnSingleFileUploadError?: boolean;
  }
  - Optional abortSignal?: AbortSignal
  - Optional name?: string
  - Optional onDirectoryCreated?: ((item) => void)
    - (item): void
      Parameters
      item: CloudItem
      Returns void
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional onUploaded?: ((item) => Promise<void>)
    - (item): Promise<void>
      Parameters
      item: CloudItem
      Returns Promise<void>
  - parent: string
  - Optional pauseSignal?: PauseSignal
  - source: string
  - Optional throwOnSingleFileUploadError?: boolean
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:4403

uploadLocalFile

uploadLocalFile(param0): Promise<CloudItem>
Upload a local file. Only available in a Node.JS environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      name?: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      onUploaded?: ((item) => Promise<void>);
      parent: string;
      pauseSignal?: PauseSignal;
      source: string;
  }
  - Optional abortSignal?: AbortSignal
  - Optional name?: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional onUploaded?: ((item) => Promise<void>)
    - (item): Promise<void>
      Parameters
      item: CloudItem
      Returns Promise<void>
  - parent: string
  - Optional pauseSignal?: PauseSignal
  - source: string
Returns Promise<CloudItem>
Async
- Defined in src/cloud/index.ts:3572

uploadLocalFileStream

uploadLocalFileStream(param0): Promise<CloudItem>
Upload a file using Node.JS streams. It's not as fast as the normal uploadFile function since it's not completely multithreaded. Only available in a Node.JS environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      creation?: number;
      lastModified?: number;
      name: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      onUploaded?: ((item) => Promise<void>);
      parent: string;
      pauseSignal?: PauseSignal;
      source: ReadableStream;
  }
  - Optional abortSignal?: AbortSignal
  - Optional creation?: number
  - Optional lastModified?: number
  - name: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional onUploaded?: ((item) => Promise<void>)
    - (item): Promise<void>
      Parameters
      item: CloudItem
      Returns Promise<void>
  - parent: string
  - Optional pauseSignal?: PauseSignal
  - source: ReadableStream
Returns Promise<CloudItem>
Async
- Defined in src/cloud/index.ts:3885

uploadWebFile

uploadWebFile(param0): Promise<CloudItem>
Upload a web-based file, such as from an field. Only works in a browser environment.
Parameters
- param0: {
      abortSignal?: AbortSignal;
      file: File;
      name?: string;
      onError?: ((err) => void);
      onFinished?: (() => void);
      onProgress?: ProgressCallback;
      onProgressId?: string;
      onQueued?: (() => void);
      onStarted?: (() => void);
      onUploaded?: ((item) => Promise<void>);
      parent: string;
      pauseSignal?: PauseSignal;
      uuid?: string;
  }
  - Optional abortSignal?: AbortSignal
  - file: File
  - Optional name?: string
  - Optional onError?: ((err) => void)
    - (err): void
      Parameters
      err: Error
      Returns void
  - Optional onFinished?: (() => void)
    - (): void
      Returns void
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional onQueued?: (() => void)
    - (): void
      Returns void
  - Optional onStarted?: (() => void)
    - (): void
      Returns void
  - Optional onUploaded?: ((item) => Promise<void>)
    - (item): Promise<void>
      Parameters
      item: CloudItem
      Returns Promise<void>
  - parent: string
  - Optional pauseSignal?: PauseSignal
  - Optional uuid?: string
Returns Promise<CloudItem>
Async
- Defined in src/cloud/index.ts:4115

Class Cloud

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: CloudConfig

Returns Cloud

Date

Properties

Private Readonly _semaphores

Type declaration

createDirectory: ISemaphore

directoryDownloads: ISemaphore

directoryUploads: ISemaphore

downloadStream: ISemaphore

downloadToLocal: ISemaphore

share: ISemaphore

uploads: ISemaphore

Private Readonly api

Private Readonly sdk

Private Readonly sdkConfig

Readonly utils

Type declaration

signals: { PauseSignal: typeof PauseSignal; }

PauseSignal: typeof PauseSignal

utils: { calculateChunkIndices: ((param0) => [number, number]); readLocalFileChunk: ((param0) => Promise<Buffer>); readWebFileChunk: ((param0) => Promise<Buffer>); }

calculateChunkIndices: ((param0) => [number, number])

Parameters

param0: { chunks: number; end: number; start: number; }

chunks: number

end: number

start: number

Returns [number, number]

Date

Export

readLocalFileChunk: ((param0) => Promise<Buffer>)

Parameters

param0: { length: number; offset: number; path: string; }

length: number

offset: number

path: string

Returns Promise<Buffer>

Date

Export

readWebFileChunk: ((param0) => Promise<Buffer>)

Parameters

param0: { file: File; index: number; length: number; }

file: File

index: number

length: number

Returns Promise<Buffer>

Date

Export

Methods

Private addItemToDirectoryPublicLink

Parameters

param0: { expiration: PublicLinkExpiration; linkKeyEncrypted: string; linkUUID: string; metadata: FileMetadata | FolderMetadata; parent: string; type: "file" | "folder"; uuid: string; }

expiration: PublicLinkExpiration

linkKeyEncrypted: string

linkUUID: string

metadata: FileMetadata | FolderMetadata

parent: string

type: "file" | "folder"

uuid: string

Returns Promise<void>

Date

Async

changeDirectoryColor

Parameters

param0: { color: string; uuid: string; }

color: string

uuid: string

Returns Promise<void>

Date

Async

`Private` `Readonly` _semaphores

`Private` `Readonly` api

`Private` `Readonly` sdk

`Private` `Readonly` sdkConfig

`Readonly` utils

signals: {
PauseSignal: typeof PauseSignal;
}

utils: {
calculateChunkIndices: ((param0) => [number, number]);
readLocalFileChunk: ((param0) => Promise<Buffer>);
readWebFileChunk: ((param0) => Promise<Buffer>);
}

param0: {
chunks: number;
end: number;
start: number;
}

param0: {
length: number;
offset: number;
path: string;
}

param0: {
file: File;
index: number;
length: number;
}

`Private` addItemToDirectoryPublicLink

param0: {
expiration: PublicLinkExpiration;
linkKeyEncrypted: string;
linkUUID: string;
metadata: FileMetadata | FolderMetadata;
parent: string;
type: "file" | "folder";
uuid: string;
}

param0: {
color: string;
uuid: string;
}

param0: {
itemMetadata: FileMetadata | FolderMetadata;
uuid: string;
}

param0: {
itemMetadata: FileMetadata | FolderMetadata;
parent: string;
type: "file" | "directory";
uuid: string;
}

param0: {
name: string;
parent: string;
renameIfExists?: boolean;
uuid?: string;
}

`Optional` renameIfExists?: boolean

`Optional` uuid?: string

param0: {
uuid: string;
}

param0: {
uuid: string;
}

param0: {
name: string;
parent: string;
}

param0: {
key: string;
parent: string;
password?: string;
salt?: string;
uuid: string;
}

`Optional` password?: string

`Optional` salt?: string

param0: {
key: string;
uuid: string;
}

param0: {
receiverId?: number;
sharerId?: number;
trash?: boolean;
uuid: string;
}

`Optional` receiverId?: number

`Optional` sharerId?: number