Files
Asset
Asset =
object
A static asset.
Properties
asArrayBuffer()
asArrayBuffer: () =>
Promise<ArrayBuffer>
Returns
Promise<ArrayBuffer>
asJson()
asJson: <
T>() =>Promise<T>
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Returns
Promise<T>
asReadableStream()
asReadableStream: () =>
ReadableStream
Returns
ReadableStream
asString()
asString: () =>
Promise<string>
Returns
Promise<string>
AssetsSDK
AssetsSDK =
object
Utilities to interact with the plugin's static assets.
Properties
get()
get: (
path:string) =>Promise<Asset>
Get a file from the assets folder.
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
Promise<Asset>
The asset file.
FilesSDK
FilesSDK =
object
SDK for interacting with the Files page.
Properties
create()
create: (
file:File) =>Promise<HostedFile>
Uploads a file to the host.
Parameters
| Parameter | Type | Description |
|---|---|---|
file | File | The file to upload. |
Returns
Promise<HostedFile>
The uploaded file.
delete()
delete: (
id:string) =>Promise<void>
Deletes a file from the host.
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the file to delete. |
Returns
Promise<void>
The deleted file.
getAll()
getAll: () =>
HostedFile[]
Gets all hosted files.
Returns
The files.
rename()
rename: (
id:string,name:string) =>Promise<HostedFile>
Renames a file on the host.
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the file to rename. |
name | string | The new name of the file. |
Returns
Promise<HostedFile>
The renamed file.
HostedFile
HostedFile =
object
A hosted file.
Properties
createdAt
createdAt:
Date
The date the file was created.
id
id:
string
The ID of the file.
name
name:
string
The name of the file.
path
path:
string
The path of the file.
size
size:
number
The size of the file in bytes.
status
status:
"ready"|"error"
The status of the file.
updatedAt
updatedAt:
Date
The date the file was updated.