2.1.1-rc.2 • Published 4 years ago

@dada513/pufferpaneljs v2.1.1-rc.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 years ago

pufferpaneljs

A JavaScript library for interacting with PufferPanel programatically.

Installation

NPMYARN
npm install @dada513/pufferpaneljsyarn add @dada513/pufferpaneljs

Usage

Basic client:

const { PufferClient } = require("pufferpaneljs");

const client = new PufferClient(
  {
    email: "someone@example.com",
    password: "password",
  },
  "https://your-pufferpanel-instance.example.com"
);
async function main() {
  await client.login();
  const servers = await client.getServers();
  const server = servers.find((server) => server.id == "some-server-id");
  await server.connect();
  await server.console.send("test");
  console.log(await server.replayLogs());
  await server.fileManager.getFiles("/");
  const file = await server.fileManager.createFile("/index.html");
  await file.edit("Hello, world!");
  await file.delete();
  await server.disconnect();
}

main();

JSDoc

PufferPanelJS has much more classes and functions than shown in the example.
See the documentation here