liamhtml/tpy

A strongly typed Pylon API client. https://pylon.bot/

tpy

A strongly typed Pylon API client. https://pylon.bot/

Tpy is a small and simplistic Deno module that provides an easier way to interact with the Pylon API. It provides the following qualities:

• 🧬 Cross runtime support.
• 🔑 Fully typed APIs.
• 🗺 Developer-friendly error interface.
• 📄 Extensive documentation.
• 📞 Keep-alive WebSocket client.

The API documentation can be viewed on the Deno website.

Installation

npm install tpy
yarn add tpy
pnpm add tpy

If you would like to use Tpy in the browser, considering vendoring dependencies to download the type dependencies locally.

Examples

Get the token's matching user.

const client = new Tpy('PYLON_TOKEN');
const user = await client.getUser();

console.log(`Logged in as ${user.displayName} (<@${user.id}>).`);

Contributing

If you'd like to contribute, please read the contributing guide before you start working. You can start a pre-setup remote workspace immediately by opening the project in GitPod.

Legal

Pylon is a copyright (c) of Uplol Inc., all rights reserved to Uplol.

Tpy is licensed under the MIT License.