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

1.0.19 • Public • Published

entrymd

Node.js API wrapper for Entry instances.

Implements API as described here. Does not implemenet admin endpoints.

Install

npm install entrymd

Usage

new Entry("https://sentrytwo.com");

The constructor takes a server input, which determines which server to send requests to. Uses https://sentrytwo.com as the default.

Create Paste

Create a new paste with the specified content.

  • props:
    • Content: string, the content of the paste
    • CustomURL: string, the path the paste will be saved at
    • EditPassword: string, the password used to edit the paste
    • IsEditable?: boolean, determines if the paste should be editable (true by default)
    • ViewPassword?: string, encrypts paste if provided
    • ExpireOn?: string, exact date and time to delete paste on
    • GroupName?: string, group name (required if GroupSubmitPassword is provided)
    • GroupSumbmitPassword?: string, group password (required if GroupName is provided)
const client = new Entry();
await client.NewPaste({
    Content: "test paste",
    CustomURL: "test",
    EditPassword: "12345",
    IsEditable: true,
    ViewPassword: "12345",
    ExpireOn: new Date().toUTCString(),
    GroupName: "test",
    GroupSubmitPassword: "12345",
});

Edit Paste

Edit an existing paste.

  • props:
    • Content: string, the new content of the paste
    • CustomURL: string, the path the paste is saved at
    • EditPassword: string, the paste edit password
    • NewEditPassword?: string, the password to change the paste edit password to (password does not change if this is not provided)
    • NewCustomURL?: string, the path to change the paste path to (path does not change if this is not provided)
const client = new Entry();
await client.EditPaste({
    Content: "test 1",
    CustomURL: "test",
    EditPassword: "12345",
    NewEditPassword: "54321",
    NewCustomURL: "test1",
});

Delete Paste

Delete an existing paste.

  • props:
    • CustomURL: string, the path the paste is saved at
    • EditPassword: string, the paste edit password
const client = new Entry();
await client.DeletePaste({
    CustomURL: "test1",
    EditPassword: "54321",
});

Get Paste

Get an existing paste.

  • CustomURL: string, the path the paste is saved at
const client = new Entry();
await client.GetPaste("example");

Decrypt Paste

Decrypt a private paste.

  • props:
    • CustomURL: string, the path the paste is saved at
    • ViewPassword: string, the paste view password
const client = new Entry();
await client.GetPaste({
    CustomURL: "test",
    ViewPassword: "12345",
});

Development

Requires Bun

  • Clone repository (git clone https://codeberg.org/hkau/entry)
  • cd into directory (cd packages/api)
  • Install dependencies (bun i)
  • Format (bun run format)
  • Build (bun run build)

Readme

Keywords

none

Package Sidebar

Install

npm i entrymd

Weekly Downloads

1

Version

1.0.19

License

MIT

Unpacked Size

13.1 kB

Total Files

6

Last publish

Collaborators

  • hkau