File Storage is an easy to use disk API that you can interact via RDK.
- You cannot set more than 5 files in parallel.
- You cannot get more than 10 files in parallel.
- You cannot delete more than 5 files in parallel.
interface GetFile {
filename: string
}
interface SetFile extends GetFile {
body: string
}
interface OperationResponse {
success: boolean
data?: any
error?: string
}
async function getFile(input: GetFile): Promise<OperationResponse | undefined> {
}
async function setFile(input: SetFile): Promise<OperationResponse | undefined> {
}
async function deleteFile(input: GetFile): Promise<OperationResponse | undefined> {
}
Usage
import RDK from '@retter/rdk'
const rdk = new RDK()
await rdk.setFile({ filename: 'my-file', body: 'my-content' })
await rdk.getFile({ filename: 'my-file' })
await rdk.deleteFile({ filename: 'my-file' })
await rdk.pipeline()
.setFile({ filename: 'my-file', body: 'my-content' })
.getFile({ filename: 'my-file' })
.deleteFile({ filename: 'my-file' })
.send()
API Reference
| Parameter | Type | Required | Description |
|---|
| filename | string | true | File's name |
| body | string | true | File's content |
| Parameter | Type | Required | Description |
|---|
| filename | string | true | File's name |
| returnSignedURL | boolean | false | Flag for retrieving signed url instead of file content |
| Parameter | Type | Required | Description |
|---|
| filename | string | true | File's name |
Operation Output
| Parameter | Type | Required | Description |
|---|
| success | boolean | true | Returns true if operation is successful |
| data | any | false | Successful response |
| error | string | false | Reason of failure |