npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

telegraph-wrapper

v1.0.2

Published

Telegra.ph API wrapper with docs and files upload

Downloads

37

Readme

Help

Rate me

telegraph-wrapper

Telegra.ph API wrapper

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

Import

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'

Methods

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) {
  /* ... */
}

Upload

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

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

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

or 

upload('./meme.png')

Types

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,
};