SpaceFilesClient

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

new SpaceFilesClient()

new SpaceFilesClient(dart): SpaceFilesClient

Parameters

Parameter	Type
dart	any

Returns

SpaceFilesClient

Source

src/dapi.ts:909

Properties

Property	Type
dart	any

Methods

copy()

copy(files, destinationPath): Promise<void>

Copies files to a destination path

Parameters

Parameter	Type
files	(string | FileInfo)[]
destinationPath	string

Returns

Promise<void>

Source

src/dapi.ts:958

---

createDirectory()

createDirectory(file): Promise<void>

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>

Source

src/dapi.ts:941

---

delete()

delete(file): Promise<void>

Deletes a file or directory

Parameters

Parameter	Type
file	string | FileInfo

Returns

Promise<void>

Source

src/dapi.ts:964

---

exists()

exists(file): Promise<boolean>

Checks if a file exists

Parameters

Parameter	Type
file	string | FileInfo

Returns

Promise<boolean>

Source

src/dapi.ts:914

---

move()

move(files, newPath): Promise<void>

Moves files to a new path

Parameters

Parameter	Type
files	(string | FileInfo)[]
newPath	string | FileInfo

Returns

Promise<void>

Source

src/dapi.ts:951

---

readAsBytes()

readAsBytes(file): Promise<Uint8Array>

Reads file content as bytes

Parameters

Parameter	Type
file	string | FileInfo

Returns

Promise<Uint8Array>

Source

src/dapi.ts:919

---

readAsString()

readAsString(file): Promise<string>

Reads file content as string

Parameters

Parameter	Type
file	string | FileInfo

Returns

Promise<string>

Source

src/dapi.ts:924

---

rename()

rename(file, newName): Promise<void>

Renames a file or directory. If renaming directory, underlying subspace will be renamed.

Parameters

Parameter	Type
file	string | FileInfo
newName	string

Returns

Promise<void>

Source

src/dapi.ts:946

---

write()

write(file, bytes): Promise<void>

Uploads file content

Parameters

Parameter	Type
file	string | FileInfo
bytes	number[]

Returns

Promise<void>

Source

src/dapi.ts:929

---

writeString()

writeString(file, data): Promise<void>

Parameters

Parameter	Type
file	string | FileInfo
data	string

Returns

Promise<void>

Source

src/dapi.ts:933