npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lavalink-api-client

v1.0.2

Published

Type-safe API client for Lavalink

Downloads

356

Readme

Lavalink API Client

A type-safe API client for Lavalink, it uses the lavalink-protocol package.

  • Compatible with Lavalink v4 Beta 3

🛟 Need Support?

Feel free to join our Discord Server.

🧑‍💻 Examples

To start using lavalink-api-client you must create an API client.

import { LavalinkAPIClient } from "lavalink-api-client";

const client = new LavalinkAPIClient({
    host: "127.0.0.1",
    port: 2333,
    auth: "youshallnotpass",
});

📡 Making Requests

You can either make the requests manually or use our custom type-safe methods for each endpoint.

Manual Requests

This is great if you want to make a request to an endpoint that isn't supported by the client or if you just want to break the rules :3

import type { RESTGetAPINodeInfo } from "lavalink-protocol";

const response = await client.execute({
    path: "/v4/info",
    method: "GET",
});

const data: RESTGetAPINodeInfo = await response.json();
// Hope and pray that the data is correct.

Type-safe helpers

These ensure that the data from the JSON body, query parameters, and response body are in compliance with the lavalink protocol.

Syntax is execute<Endpoint>(client, request info, extra request options)

import { executeInfo } from "lavalink-api-client";

const response = await executeInfo(client, {}, {});
//    ^? RESTGetAPINodeInfo

❌ Error Handling

Error handling is a #1 priority for us, so we've made it extremely easy to handle errors.

import { isLavalinkHTTPError, isLavalinkAPIError } from "lavalink-api-client";

try {
    // execute a request.
} catch (ex) {
    if (isLavalinkAPIError(ex)) {
        // handle API error.
        console.log(ex.data.status);
    }

    if (isLavalinkHTTPError(ex)) {
        // handle HTTP error.
    }
}

The different reasons an HTTP error may occur are:

  1. The response body couldn't be decoded.
  2. The request failed to send.
  3. Lavalink returned an error.
  4. Something unknown happened.
  5. A validation error occurred.
  6. The request was aborted.

Differences between an HTTP and API Error:

  • LavalinkHTTPError's are thrown when something went wrong somewhere in the request - most originate from the client.
  • LavalinkAPIError's are thrown when Lavalink returns a non 2.x.x status code - although these extend HTTP errors, they only originate from Lavalink.

tl;dr HTTP errors indicate a general error, API errors indicate Lavalink returned an error.


lavaclient © 2020 - Current Year