GramIO API Reference / @gramio/files/dist / MediaUpload

Class: MediaUpload

Defined in: files/index.d.ts:86

Class-helper with static methods for file uploading.

Documentation

Constructors

Constructor

new MediaUpload(): MediaUpload

Returns

MediaUpload

Methods

buffer()

static buffer(buffer, filename?): File

Defined in: files/index.d.ts:98

Method for uploading Media File by BinaryLike (Buffer or ArrayBuffer and etc).

Parameters

Parameter	Type
buffer	any
filename?	string

Returns

File

---

path()

static path(path, filename?): Promise<File>

Defined in: files/index.d.ts:90

Method for uploading Media File by local path.

Parameters

Parameter	Type
path	string
filename?	string

Returns

Promise<File>

---

stream()

static stream(stream, filename?): Promise<File>

Defined in: files/index.d.ts:94

Method for uploading Media File by Readable stream.

Parameters

Parameter	Type
stream	Readable | ReadableStream<any>
filename?	string

Returns

Promise<File>

---

text()

static text(text, filename?): File

Defined in: files/index.d.ts:106

Method for uploading Media File by text content.

Parameters

Parameter	Type
text	string
filename?	string

Returns

File

---

url()

static url(url, filename?, options?): Promise<File>

Defined in: files/index.d.ts:102

Method for uploading Media File by URL (also with fetch options).

Parameters

Parameter	Type
url	string | URL
filename?	string
options?	RequestInit

Returns

Promise<File>