Class FS

Date

2/1/2024 - 2:44:47 AM

Export

Index

Constructors

constructor

Properties

_items _uuidToItem api cloud itemsMutex mkdirMutex mutex sdkConfig socket

Constructors

constructor

new FS(params): FS
Creates an instance of FS.
Parameters
- params: FSConfig
Returns FS
Date
2/9/2024 - 5:54:11 AM
- Defined in src/fs/index.ts:114

Properties

_items

_items: FSItems

_uuidToItem

_uuidToItem: Record<string, FSItemUUID>

`Private` `Readonly` api

api: API

`Private` `Readonly` cloud

cloud: Cloud

`Private` `Readonly` itemsMutex

itemsMutex: ISemaphore = ...

`Private` `Readonly` mkdirMutex

mkdirMutex: ISemaphore = ...

`Private` `Readonly` mutex

mutex: ISemaphore = ...

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

`Private` `Readonly` socket

socket: Socket = ...

Methods

_addItem

_addItem(param0): Promise<void>
Add an item to the internal item tree.
Parameters
- param0: {
  item: FSItem;
  path: string;
  }
  - item: FSItem
  - path: string
Returns Promise<void>
Async
- Defined in src/fs/index.ts:316

`Private` _initSocketEvents

_initSocketEvents(connect?): Promise<void>
Private
Attach listeners for relevant realtime events.
Parameters
- Optional connect: boolean
Returns Promise<void>
Async
- Defined in src/fs/index.ts:176

_removeItem

_removeItem(param0): Promise<void>
Remove an item from the internal item tree.
Parameters
- param0: {
  path: string;
  }
  - path: string
Returns Promise<void>
Async
- Defined in src/fs/index.ts:337

`Private` _unlink

_unlink(param0): Promise<void>
Private
Deletes file/directoy at path.
Parameters
- param0: {
      path: string;
      permanent?: boolean;
      type?: FSItemType;
  }
  - path: string
  - Optional permanent?: boolean
  - Optional type?: FSItemType
Returns Promise<void>
Date
2/28/2024 - 4:57:19 PM

Async
- Defined in src/fs/index.ts:1080

copy

copy(...params): Promise<void>
Alias of cp.
Parameters
- Rest ...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
- Defined in src/fs/index.ts:1941

cp

cp(param0): 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;
  }
  - Optional abortSignal?: AbortSignal
  - from: string
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional pauseSignal?: PauseSignal
  - to: string
Returns Promise<void>
Async
- Defined in src/fs/index.ts:1756

download

download(param0): 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;
  }
  - Optional abortSignal?: AbortSignal
  - destination: string
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - path: string
  - Optional pauseSignal?: PauseSignal
Returns Promise<void>
Async
- Defined in src/fs/index.ts:1507

ls

ls(...params): Promise<string[]>
Alias of readdir.
Parameters
- Rest ...params: [{
  path: string;
  recursive?: boolean;
  }]
Returns Promise<string[]>
Date
2/13/2024 - 8:48:40 PM

Async
- Defined in src/fs/index.ts:686

lstat

lstat(...params): Promise<FSStats>
Alias of stat.
Parameters
- Rest ...params: [{
  path: string;
  }]
Returns Promise<FSStats>
Date
2/13/2024 - 8:49:18 PM

Async
- Defined in src/fs/index.ts:744

mkdir

mkdir(param0): Promise<string>
Creates a directory at path. Recursively creates intermediate directories if they don't exist.
Parameters
- param0: {
  path: string;
  }
  - path: string
Returns Promise<string>
Date
2/14/2024 - 1:34:11 AM

Async
- Defined in src/fs/index.ts:758

`Private` normalizePath

normalizePath(param0): string
Private
Normalizes a path to be used with FS.
Parameters
- param0: {
  path: string;
  }
  - path: string
Returns string
Date
2/14/2024 - 12:50:52 AM
- Defined in src/fs/index.ts:364

pathToItemUUID

pathToItemUUID(__namedParameters): Promise<null | string>
Parameters
- __namedParameters: {
  path: string;
  type?: FSItemType;
  }
  - path: string
  - Optional type?: FSItemType
Returns Promise<null | string>
- Defined in src/fs/index.ts:378

read

read(param0): 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;
  }
  - Optional abortSignal?: AbortSignal
  - Optional length?: number
  - Optional offset?: number
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - path: string
  - Optional pauseSignal?: PauseSignal
  - Optional position?: number
Returns Promise<Buffer>
Async
- Defined in src/fs/index.ts:1230

readFile

readFile(param0): 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;
  }
  - Optional abortSignal?: AbortSignal
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - path: string
  - Optional pauseSignal?: PauseSignal
Returns Promise<Buffer>
Async
- Defined in src/fs/index.ts:1339

readdir

readdir(param0): Promise<string[]>
List files and directories at path.
Parameters
- param0: {
  path: string;
  recursive?: boolean;
  }
  - path: string
  - Optional recursive?: boolean
Returns Promise<string[]>
Date
2/20/2024 - 2:40:03 AM

Async
- Defined in src/fs/index.ts:506

rename

rename(param0): Promise<void>
Rename or move a file/directory. Recursively creates intermediate directories if needed.
Parameters
- param0: {
  from: string;
  to: string;
  }
  - from: string
  - to: string
Returns Promise<void>
Date
2/14/2024 - 1:39:32 AM

Async
- Defined in src/fs/index.ts:881

rm

rm(param0): Promise<void>
Alias of unlink.
Parameters
- param0: {
  path: string;
  permanent?: boolean;
  }
  - path: string
  - Optional permanent?: boolean
Returns Promise<void>
Date
2/28/2024 - 4:58:30 PM

Async
- Defined in src/fs/index.ts:1165

rmdir

rmdir(...params): Promise<void>
Deletes directory at path.
Parameters
- Rest ...params: [{
  path: string;
  permanent?: boolean;
  }]
Returns Promise<void>
Date
2/14/2024 - 2:53:48 AM

Async
- Defined in src/fs/index.ts:1181

rmfile

rmfile(...params): Promise<void>
Deletes a file at path.
Parameters
- Rest ...params: [{
  path: string;
  permanent?: boolean;
  }]
Returns Promise<void>
Async
- Defined in src/fs/index.ts:1197

stat

stat(__namedParameters): Promise<FSStats>
Parameters
- __namedParameters: {
  path: string;
  }
  - path: string
Returns Promise<FSStats>
- Defined in src/fs/index.ts:690

statfs

statfs(): Promise<StatFS>
Returns filesystem information.

Returns Promise<StatFS>
Date
2/14/2024 - 2:13:19 AM

Async
- Defined in src/fs/index.ts:1052

unlink

unlink(param0): Promise<void>
Deletes file/directory at path.
Parameters
- param0: {
  path: string;
  permanent?: boolean;
  }
  - path: string
  - Optional permanent?: boolean
Returns Promise<void>
Date
2/28/2024 - 4:58:37 PM

Async
- Defined in src/fs/index.ts:1147

upload

upload(param0): 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;
  }
  - Optional abortSignal?: AbortSignal
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - Optional overwriteDirectory?: boolean
  - path: string
  - Optional pauseSignal?: PauseSignal
  - source: string
Returns Promise<CloudItem>
Async
- Defined in src/fs/index.ts:1588

`Private` waitForValidAPIKey

waitForValidAPIKey(): Promise<string>
Private
Wait for an API key (login) to become available

Returns Promise<string>
Async
- Defined in src/fs/index.ts:152

write

write(...params): Promise<CloudItem>
Alias of writeFile.
Parameters
- Rest ...params: [{
      abortSignal?: AbortSignal;
      content: Buffer;
      onProgress?: ProgressCallback;
      onProgressId?: string;
      path: string;
      pauseSignal?: PauseSignal;
  }]
Returns Promise<CloudItem>
Date
2/20/2024 - 9:45:40 PM

Async
- Defined in src/fs/index.ts:1316

writeFile

writeFile(param0): 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;
      onProgress?: ProgressCallback;
      onProgressId?: string;
      path: string;
      pauseSignal?: PauseSignal;
  }
  - Optional abortSignal?: AbortSignal
  - content: Buffer
  - Optional onProgress?: ProgressCallback
  - Optional onProgressId?: string
  - path: string
  - Optional pauseSignal?: PauseSignal
Returns Promise<CloudItem>
Async
- Defined in src/fs/index.ts:1382

Class FS

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: FSConfig

Returns FS

Date

Properties

_items

_uuidToItem

Private Readonly api

Private Readonly cloud

Private Readonly itemsMutex

Private Readonly mkdirMutex

Private Readonly mutex

Private Readonly sdkConfig

Private Readonly socket

Methods

_addItem

Parameters

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

item: FSItem

path: string

Returns Promise<void>

Async

Private _initSocketEvents

Parameters

Optional connect: boolean

Returns Promise<void>

Async

_removeItem

Parameters

param0: { path: string; }

path: string

Returns Promise<void>

Async

Private _unlink

Parameters

param0: { path: string; permanent?: boolean; type?: FSItemType; }

path: string

Optional permanent?: boolean

Optional type?: FSItemType

Returns Promise<void>

Date

Async

copy

Parameters

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

Returns Promise<void>

Date

Async

cp

Parameters

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

Optional abortSignal?: AbortSignal

from: string

Optional onProgress?: ProgressCallback

Optional onProgressId?: string

Optional pauseSignal?: PauseSignal

to: string

Returns Promise<void>

Async

download

Parameters

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

Optional abortSignal?: AbortSignal

destination: string

Optional onProgress?: ProgressCallback

Optional onProgressId?: string

path: string

Optional pauseSignal?: PauseSignal

Returns Promise<void>

Async

ls

`Private` `Readonly` api

`Private` `Readonly` cloud

`Private` `Readonly` itemsMutex

`Private` `Readonly` mkdirMutex

`Private` `Readonly` mutex

`Private` `Readonly` sdkConfig

`Private` `Readonly` socket

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

`Private` _initSocketEvents

`Optional` connect: boolean

param0: {
path: string;
}

`Private` _unlink

param0: {
path: string;
permanent?: boolean;
type?: FSItemType;
}

`Optional` permanent?: boolean

`Optional` type?: FSItemType

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

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

`Optional` abortSignal?: AbortSignal

`Optional` onProgress?: ProgressCallback

`Optional` onProgressId?: string

`Optional` pauseSignal?: PauseSignal

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

`Optional` abortSignal?: AbortSignal

`Optional` onProgress?: ProgressCallback

`Optional` onProgressId?: string

`Optional` pauseSignal?: PauseSignal

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

`Rest` ...params: [{
path: string;
}]

param0: {
path: string;
}

`Private` normalizePath

param0: {
path: string;
}

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

`Optional` type?: FSItemType

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

`Optional` abortSignal?: AbortSignal

`Optional` length?: number

`Optional` offset?: number

`Optional` onProgress?: ProgressCallback

`Optional` onProgressId?: string

`Optional` pauseSignal?: PauseSignal

`Optional` position?: number

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

`Optional` abortSignal?: AbortSignal

`Optional` onProgress?: ProgressCallback

`Optional` onProgressId?: string

`Optional` pauseSignal?: PauseSignal

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

`Optional` recursive?: boolean

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