Skip to main content

api.upload()

View Source: upload

function upload(file, options?): Promise<{
  id: string;
  url: string;
}>;

Description​

Upload a file to the server.

Sample Code​

TypeScript Example:

// Example usage of api.upload()
const result = await api.upload();
console.log(result);

Parameters​

file​

File

The file to upload

options?​

Upload configuration options

onProgress?​

(progress) => void

Returns​

Promise<{ id: string; url: string; }>

Promise resolving to upload result with file ID

Example​

const result = await api.upload(myFile, { 
  onProgress: (p) => console.log(`${p}% complete`) 
});