{"id":19784343,"url":"https://github.com/pteropackages/pterojslite","last_synced_at":"2025-06-29T00:36:33.419Z","repository":{"id":41984757,"uuid":"456721554","full_name":"PteroPackages/PteroJSLite","owner":"PteroPackages","description":"A lightweight alternative to PteroJS","archived":false,"fork":false,"pushed_at":"2022-12-30T16:52:31.000Z","size":110,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-20T00:12:19.603Z","etag":null,"topics":["api","javascript","pterodactyl","pterodactyl-api","pterojs","pterojslite","typescript","wrapper"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PteroPackages.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-08T00:05:11.000Z","updated_at":"2023-02-27T10:12:46.000Z","dependencies_parsed_at":"2023-01-31T12:01:39.642Z","dependency_job_id":null,"html_url":"https://github.com/PteroPackages/PteroJSLite","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJSLite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJSLite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJSLite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJSLite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PteroPackages","download_url":"https://codeload.github.com/PteroPackages/PteroJSLite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251791744,"owners_count":21644449,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","javascript","pterodactyl","pterodactyl-api","pterojs","pterojslite","typescript","wrapper"],"created_at":"2024-11-12T06:11:13.443Z","updated_at":"2025-04-30T22:32:08.185Z","avatar_url":"https://github.com/PteroPackages.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003ePteroJSLite\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003e\u003cstrong\u003eA lightweight alternative to PteroJS\u003c/strong\u003e\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://discord.com/invite/dwcfTjgn7S\" type=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-join-5865f2?style=for-the-badge\u0026logo=discord\u0026logoColor=white\"\u003e\u003c/a\u003e \u003cimg src=\"https://img.shields.io/badge/version-1.1.0-3572A5?style=for-the-badge\"\u003e \u003cimg src=\"https://img.shields.io/github/issues/PteroPackages/PteroJSLite.svg?style=for-the-badge\"\u003e \u003c!--\u003ca href=\"https://pteropackages.github.io/PteroJS/\" type=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-typedoc-e67e22?style=for-the-badge\"\u003e\u003c/a\u003e--\u003e\u003c/p\u003e\n\n## About\n\nPteroJSLite is a lightweight alternative to [PteroJS](https://github.com/PteroPackages/PteroJS) using only objects and functions - absolutely no classes! This package is ideal if you want a high-level package without the abstractions and helper methods of larger libraries, while still getting same amount of functionality.\n\n## Installing\n\nYou must have NodeJS v14 or above to use this package.\n\n```\nnpm install @devnote-dev/pterojslite\nyarn add @devnote-dev/pterojslite\n```\n\n## Compatibility\n\nPteroJSLite supports version 1.7+ of the panel, and version 1.6+ of Wings.\n\n## Getting Started\n\nApplication and Client API instances can be created using the `createApp` and `createClient` functions respectively. Both application keys (`ptla`) and client keys (`ptlc`) are currently supported.\n\n```js\nconst { createApp } = require('@devnote-dev/pterojslite');\n\nconst app = createApp('https://your.panel.domain', 'ptla_your_api_key');\n\napp.getServers().then(console.log);\n\n(async () =\u003e {\n    const users = await app.getUsers(); // returns an array of user objects\n    console.log(users.filter(u =\u003e u.rootAdmin)); // filters out non-admin users\n})();\n```\n\n```js\nconst { createClient } = require('@devnote-dev/pterojslite');\n\nconst client = createClient('https://your.panel.domain', 'ptlc_your_api_key');\n\nclient.getAccount().then(console.log);\n\n(async () =\u003e {\n    const activities = await app.getActivities(); // returns an array of activity logs\n    console.log(activities.filter(a =\u003e a.isAPI)); // filters out non-API activities\n})();\n```\n\n## Contributing\n\nPlease [create an issue](https://github.com/PteroPackages/PteroJSLite/issues) for issues or feature requests for the package.\n\n1. [Fork this repo](https://github.com/PteroPackages/PteroJSLite/fork)!\n2. Make a branch from `main` (`git branch -b \u003cnew-feature\u003e`)\n3. Commit your changes (`git commit -am \"...\"`)\n4. Open a PR here (`git push origin \u003cnew-feature\u003e`)\n\n## Contributors\n\n- [Devonte](https://github.com/devnote-dev) - Owner, maintainer\n- [Tlkh40](https://github.com/tlkh40) - Code contributor\n\nThis repository is managed under the MIT license.\n\n© 2021-present PteroPackages\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpteropackages%2Fpterojslite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpteropackages%2Fpterojslite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpteropackages%2Fpterojslite/lists"}