SpaceFilesClient
Defined in: js-api/src/dapi.ts:1199
Client for file operations within a space's storage. Files in a space are stored in the space's dedicated storage connection. Directory operations are synchronized with the space hierarchy - creating a directory creates a corresponding subspace, and renaming a directory renames the subspace.
Constructors
Constructor
new SpaceFilesClient(
dart):SpaceFilesClient
Defined in: js-api/src/dapi.ts:1202
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
SpaceFilesClient
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | js-api/src/dapi.ts:1200 |
Methods
copy()
copy(
files,destinationPath):Promise<void>
Defined in: js-api/src/dapi.ts:1251
Copies files to a destination path
Parameters
| Parameter | Type |
|---|---|
files | (string | FileInfo)[] |
destinationPath | string |
Returns
Promise<void>
createDirectory()
createDirectory(
file):Promise<void>
Defined in: js-api/src/dapi.ts:1234
Creates a directory within this space's storage. This automatically creates a corresponding subspace with the same name (normalized). The subspace will have its own namespaced storage path.
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
Returns
Promise<void>
delete()
delete(
file):Promise<void>
Defined in: js-api/src/dapi.ts:1257
Deletes a file or directory
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
Returns
Promise<void>
exists()
exists(
file):Promise<boolean>
Defined in: js-api/src/dapi.ts:1207
Checks if a file exists
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
Returns
Promise<boolean>
move()
move(
files,newPath):Promise<void>
Defined in: js-api/src/dapi.ts:1244
Moves files to a new path
Parameters
| Parameter | Type |
|---|---|
files | (string | FileInfo)[] |
newPath | string | FileInfo |
Returns
Promise<void>
readAsBytes()
readAsBytes(
file):Promise<Uint8Array<ArrayBufferLike>>
Defined in: js-api/src/dapi.ts:1212
Reads file content as bytes
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
Returns
Promise<Uint8Array<ArrayBufferLike>>
readAsString()
readAsString(
file):Promise<string>
Defined in: js-api/src/dapi.ts:1217
Reads file content as string
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
Returns
Promise<string>
rename()
rename(
file,newName):Promise<void>
Defined in: js-api/src/dapi.ts:1239
Renames a file or directory. If renaming directory, underlying subspace will be renamed.
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
newName | string |
Returns
Promise<void>
write()
write(
file,bytes):Promise<void>
Defined in: js-api/src/dapi.ts:1222
Uploads file content
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
bytes | number[] | Uint8Array<ArrayBufferLike> |
Returns
Promise<void>
writeString()
writeString(
file,data):Promise<void>
Defined in: js-api/src/dapi.ts:1226
Parameters
| Parameter | Type |
|---|---|
file | string | FileInfo |
data | string |
Returns
Promise<void>