Yurba.js

Appearance

Yurba.js / @yurbajs/rest / FilesResource

Class: FilesResource ​

Files Core ​

delete() ​

delete(fileId): Promise<BaseOkay>

Deletes a file

Parameters ​

fileId ​

number

File identifier

Returns ​

Promise<BaseOkay>

BaseDelete Delete response

Since ​

1.0.0

Throws ​

If file ID is invalid

Example ​

javascript
await rest.files.delete(14);

get() ​

get(fileId): Promise<File>

Gets a file by identifier

Parameters ​

fileId ​

number

File identifier

Returns ​

Promise<File>

File object

Since ​

1.0.0

Throws ​

If file ID is invalid

Example ​

javascript
const file = await rest.files.get(23);

getAll() ​

getAll(page?): Promise<File[]>

Gets all files

Parameters ​

page? ​

number

Page number (optional)

Returns ​

Promise<File[]>

Array of File objects

Since ​

1.0.0

Throws ​

If page number is invalid

Example ​

javascript
const files = await rest.files.getAll();
const nextPage = await rest.files.getAll(1);

upload() ​

upload(input, filename?): Promise<File>

Uploads a file

Parameters ​

input ​

Path to file or Buffer

string | Buffer<ArrayBufferLike>

filename? ​

string

Custom filename (optional)

Returns ​

Promise<File>

File Uploaded file

Since ​

1.0.0

Throws ​

If input is invalid

Example ​

javascript
const file = await rest.files.upload('/path/to/file.txt');
// or with Buffer
const file = await rest.files.upload(buffer, 'document.pdf');