1.0.5 • Published 2 years ago

paste.gg v1.0.5

Weekly downloads
69
License
MIT
Repository
github
Last release
2 years ago

Links

API Documentation GitHub NPM

Usages

Install the stable version

npm install paste.gg

yarn add paste.gg

Install the beta version (git is required)

npm install SerenModz21/paste.gg#beta

yarn add SerenModz21/paste.gg#beta

Get started with paste.gg

const PasteGG = require("paste.gg");
// or
import PasteGG from "paste.gg";

// If you want to be anonymous
const pasteGG = new PasteGG()

// If you want to use an api key
const pasteGG = new PasteGG("apiKeyHere")

Get information about a post

// if you would like to exclude file contents
await pasteGG.get("idHere")

// If you would like to include file contents
await pasteGG.get("idHere", true)

Post a new paste (Click here for more options)

await pasteGG.post({
  name: "Paste name", // Optional
  description: "Paste description", // Optional
  expires: "2020-12-21T02:25:56.428Z", // Optional (must be a UTC ISO 8601 string)
  files: [{
    name: "file.txt", // Optional
    content: {
      format: "text",
      value: "This is where the file content will go"
    }
  }]
})

Delete a paste (auth/deletion key needed)

// Delete with deletion key
await pasteGG.delete("idHere", "deletionKeyHere")

// Delete with auth key if not set in constructor
await pasteGG.delete("idHere", "authKeyHere") 

// Leave blank if auth key is in the class constructor
await pasteGG.delete("idHere")

Update the post

await pasteGG.update("idHere", {
  name: "new name", // Optional (if you want to remove the name)
  description: "new description"
})

Contributions are more than welcome. If you would like to add to this API, you can open a pull request as I haven't added everything on the API, only the things that will get used more often.

Copyright © SerenModz21 2018 - 2021