gist-box
TypeScript icon, indicating that this package has built-in type declarations

0.3.1 • Public • Published

GistBox

📌📋 A helper class for updating a single-file Gist

NPM Build Status Codecov

Usage

Installation

$ npm install gist-box
const { GistBox } = require('gist-box')

API

const box = new GistBox({ id, token })
await box.update({
  filename: 'example.md',
  description: 'A new description',
  content: 'The new content'
})

You can also import some boundary numbers to use when dealing with pinned Gists:

const {
  MAX_LENGTH, // The number of characters rendered in one line 
  MAX_LINES,  // The number of lines it will render
  MAX_HEIGHT, // The height of the box, in pixels
  MAX_WIDTH   // The width of the box, in pixels
= require('gist-box')

Shoutout to @matchai for starting this trend with bird-box!

Readme

Keywords

Package Sidebar

Install

npm i gist-box

Weekly Downloads

10,838

Version

0.3.1

License

MIT

Unpacked Size

11.9 kB

Total Files

9

Last publish

Collaborators

  • jasonetco