Yurba.js

Appearance

Class: FilesResource ​

Files Core ​

delete() ​

DELETE /files/{file_id} No API Docs

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 /files/{file_id} No API Docs

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() ​

GET /files No API Docs

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() ​

POST /files No API Docs

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

Uploads a file from Blob, File, Buffer, or file path (Node.js only)

Parameters ​

file ​

File, Blob, Buffer, or file path (string)

string | Blob | Buffer<ArrayBufferLike>

filename? ​

string

Custom filename (required for Buffer/Blob, optional for path)

Returns ​

Promise<File>

File Uploaded file

Since ​

1.0.0

Throws ​

If input is invalid

Example ​

javascript
// Browser: Upload File from input
const fileInput = document.querySelector('input[type="file"]');
const file = await rest.files.upload(fileInput.files[0]);

// Browser: Upload Blob
const blob = new Blob(['content'], { type: 'text/plain' });
const file = await rest.files.upload(blob, 'document.txt');

// Node.js: Upload Buffer
const buffer = Buffer.from('content');
const file = await rest.files.upload(buffer, 'document.txt');

// Node.js: Upload from file path
const file = await rest.files.upload('./document.pdf');