Socket
Socket
Sign inDemoInstall

paste.gg

Package Overview
Dependencies
7
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    paste.gg

An easy-to-use library for interacting with the Paste.GG API. Contains examples, strong JSDocs, TypeScript types, and support for Node.js 12+. Works in both JavaScript and TypeScript.


Version published
Weekly downloads
833
decreased by-21.12%
Maintainers
1
Install size
514 kB
Created
Weekly downloads
 

Readme

Source

paste.gg

NPM version NPM downloads Build status GitHub code size

A library for interacting with the Paste.GG API. I have created this in a short amount of time and will expect more updates in the future. The main purpose of this is to help users from having to create API calls.

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

Keywords

FAQs

Last updated on 23 Jan 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc