opex-telegraph-uploader v2.1.3

opex-telegraph-uploader

Модуль для загрузки изображений на сервис Telegraph.

Установка

npm install opex-telegraph-uploader

ES6

import { upload, uploadByUrl, uploadByBuffer, uploadByPath } from 'opex-telegraph-uploader';

CommonJS

const { upload, uploadByUrl, uploadByBuffer, uploadByPath } = require('opex-telegraph-uploader');

Примечание:

• Поддерживаются форматы изображений: JPEG (.jpg, .jpeg) и PNG (.png).

API

upload(input, agent)

Универсальная функция для загрузки изображений. Автоматически определяет тип входных данных и использует соответствующий метод загрузки.

Параметры:

• input (string | Buffer): URL изображения, путь к файлу или Buffer с данными изображения.
• agent (optional): HTTP/HTTPS агент для выполнения запроса.

Возвращает:

• Promise: Объект с информацией о загруженном изображении.
  • link (string): Полный URL загруженного изображения.
  • path (string): Путь к изображению на сервере Telegraph.

Примеры:

// Загрузка по URL
const result1 = await upload('https://example.com/image.jpg');
console.log(result1.link);

// Загрузка локального файла
const result2 = await upload('/path/to/local/image.png');
console.log(result2.link);

// Загрузка из Buffer
const buffer = Buffer.from('...'); // данные изображения
const result3 = await upload(buffer);
console.log(result3.link);

uploadByUrl(url, agent)

Загружает изображение по указанному URL.

Параметры:

• url (string): URL изображения для загрузки.
• agent (optional): HTTP/HTTPS агент для выполнения запроса.

Возвращает:

• Promise: Объект с информацией о загруженном изображении (см. upload).

Пример:

const result = await uploadByUrl('https://example.com/image.jpg');
console.log(result.link);

uploadByBuffer(buffer, contentType, agent)

Загружает изображение из Buffer.

Параметры:

• buffer (Buffer): Buffer с данными изображения.
• contentType (string): MIME-тип изображения (например, 'image/jpeg', 'image/png').
• agent (optional): HTTP/HTTPS агент для выполнения запроса.

Возвращает:

• Promise: Объект с информацией о загруженном изображении (см. upload).

Пример:

const buffer = await fs.readFile('image.jpg');
const result = await uploadByBuffer(buffer, 'image/jpeg');
console.log(result.link);

uploadByPath(filePath, agent)

Загружает изображение из локального файла.

Параметры:

• filePath (string): Путь к локальному файлу изображения.
• agent (optional): HTTP/HTTPS агент для выполнения запроса.

Возвращает:

• Promise: Объект с информацией о загруженном изображении (см. upload).

Пример:

const result = await uploadByPath('/path/to/image.png');
console.log(result.link);

Разработчик: OpexDev