__Help__

#### __Rate me__

__telegraph-wrapper__

$3

Official docs - https://telegra.ph/api

Features

- files upload (local and remote by url)
- all types included
- full docs included
- proxy for upload (TODO)

Install

npm i telegraph-wrapper

or

yarn add telegraph-wrapper

Usage

$3

#### CommonJS

const Telegraph from 'telegraph-wrapper'

or

const { createAccount, upload } from 'telegraph-wrapper'

#### Modules
import * as Telegraph from 'telegraph-wrapper'

or

import { createAccount, upload } from 'telegraph-wrapper'

$3

All methods presented in official docs:

https://telegra.ph/api#Available-methods

Methods returns Promise with api response.

Hover any method and property to preview JSDocs.

Examples:
``
import * as Telegraph from 'telegraph-wrapper';

Telegraph.createAccount({
short_name: 'acc',
})
.then(console.log)
.catch(err => { / ... / });

`
`
import { getAccountInfo } from 'telegraph-wrapper';

getAccountInfo({
access_token: '...',
})
.then(console.log)
.catch(err => { / ... / });
`
`
import { createAccount } from 'telegraph-wrapper';

try {
const acc = await createAccount({
short_name: 'acc',
});
} catch (err) {
/ ... /
}
`

$3


Allows upload local files and remote (by url) to telegra.ph servers. Returns Promise (see #Types).

⚠️ Do not mix local and remote URLs! ⚠️

`
upload([
'./meme.png',
'./meme2.png',
])

or

upload('./meme.png')
`

$3

All types also included + upload responses.

Names are the same with official docs.

JSDocs included. You can import any type and see docs by hovering it.

#### Upload types

TelegraphOK - Telegra.ph success response

TelegraphOK[].src - Telegra.ph file link. Example: /file/123abc123abc123abc123.ext
`
type TelegraphOK = Array<{
src: string,
}>;
`

TelegraphError - Telegra.ph error response

TelegraphOK.error - Error body
`
type TelegraphError = {
error: string,
};
``