README.md

Documentation

• Return to README
• Initialize The Client
• Create a paste
• Login using name and password
• Get all pastes from user
• Delete a paste
• Get Raw Paste
• Publicity Types
• Expire Date Types

Initialize The Client

ESM

import PasteClient from "pastebin-api";

const client = new PasteClient("DEV_API_KEY");

CommonJS

const PasteClient = require("pastebin-api").default;

const client = new PasteClient("DEV_API_KEY");

Options

Name	Type	Description	Required
apiKey	string	Your dev api key	true
domain	string	Optional domain name to a custom pastebin API	false

Back To Top

Create a Paste

import { PasteClient, Publicity, ExpireDate } from "pastebin-api";
const client = new PasteClient("DEV_API_KEY");

const url = await client.createPaste({
  code: "const something = 'Hello World!'",
  expireDate: ExpireDate.Never,
  format: "javascript",
  name: "something.js",
  publicity: Publicity.Public,
});

console.log(url);

Options

Name	Type	Description	Required
code	string	The code you want to push	true
expireDate	string	Sets the expire date of the paste	false
format	string	The Syntax format	false
name	string	The name of your paste (Limit of 100 characters)	false
publicity	number	0 | 1 | 2	false
folderKey	string	The folder key(id)	false
apiUserKey	string	The user key gotten from PasteClient#login	false

Back To Top

Login using name and password

const client = new PasteClient("DEV_API_KEY");

const token = await client.login({ name: "user_name", password: "user_password" });

// This is the user token that can be used to get all the user's pastes or delete one
console.log(token);

Options

Name	Type	Description	Required
name	string	The user's name	true
password	string	The user's password	true

Back To Top

Get pastes from user

const client = new PasteClient("DEV_API_KEY");

// Login to get the token
const token = await client.login({ name: "user_name", password: "user_password" });

// Get a limit of 1000 pastes from the user
const pastes = await client.getPastesByUser({
  userKey: token,
  limit: 100, // Min: 1, Max: 1000
});

// An array of pastes
console.log(pastes);

Options

Name	Type	Description	Required
userKey	string	The token returned from PasteClient#login	true
limit	number	The limit of pastes to get	false

Back To Top

Delete a paste

const client = new PasteClient("DEV_API_KEY");

// Login to get the token
const token = await client.login({ name: "user_name", password: "user_password" });

// Will return a boolean if deleted
const deleted = await client.deletePasteByKey({
  userKey: token,
  pasteKey: "paste-key-here",
});

//=> `true` or `false`
console.log(deleted);

Options

Name	Type	Description	Required
userKey	string	The token returned from PasteClient#login	true
pasteKey	string	The key (id) of the paste	true

Back To Top

Get Raw Paste

const client = new PasteClient("DEV_API_KEY");

// Login to get the token
const token = await client.login({ name: "user_name", password: "user_password" });

const data = await client.getRawPasteByKey({
  pasteKey: "paste-key-here",
  userKey: token,
});

//=> raw paste string
console.log(data);

Options

Name	Type	Description	Required
userKey	string	The token returned from PasteClient#login	true
pasteKey	string	The key (id) of the paste	true

Back To Top

Publicity Types

Value	Type	Description
0	number	This paste will be public and listed
1	number	This paste will be unlisted
2	number	The paste will be private (Only available when logged in)

Back To Top

Expire Date Types

Value	Type	Description
N	string	Never
10M	string	10 Minutes
1H	string	1 Hour
1D	string	1 Day
1W	string	1 Week
2W	string	2 Weeks
1M	string	1 Month
6M	string	6 Months
1Y	string	1 Year

Back To Top