README.md

Gist API

npm i @tsukiroku/gist

---

Docs

Initialize

Account token required. See Docs

import Gist from "@tsukiroku/gist";

const gist = new Gist("token");

Create Gist

Parameter	Type
files	GistFile
description	string
options	GistOptions

GistFile

{ 'file name': { content: 'content' }, ... },

GistOptions

{ secret: boolean, ... }

secret default: true

return: Promise<GistResponse>

await gist
    .create(
        {
            file_name: { content: "File Content" },
            file_name_2: { content: "File Content 2" },
        },
        "test file"
        // { secret: true }
    )
    .then((res) => {
        console.log(`Gist created: ${gist_id}`);
    })
    .catch((err) => console.log(err));

Get Gist

Parameter	Type
id	number

return: Promise<GistResponse>

await gist
    .get("gist id")
    .then((res) => console.log(`gist description: ${res.description}`))
    .catch((err) => console.log(err));

Delete Gist

Parameter	Type
id	number

await gist
    .delete("gist id")
    .then((_) => console.log("deleted"))
    .catch((err) => console.log(err));

---

Example

import Gist from "@tsukiroku/gist";

(async () => {
    const gist = new Gist("token");

    let gist_id: string = "";

    await gist
        .create(
            {
                "index.ts": { content: "console.log('Hello, World!');" },
                "main.rs": { content: "fn main() {}" },
            },
            "test gist",
            { secret: true }
        )
        .then((res) => {
            gist_id = res.id;
            console.log(`Gist created: ${gist_id}`);
        })
        .catch((err) => console.log(err));

    await gist
        .get(gist_id)
        .then((res) => console.log(`gist description: ${res.description}`))
        .catch((err) => console.log(err));

    await gist
        .delete(gist_id)
        .then((_) => console.log("deleted"))
        .catch((err) => console.log(err));
})();