Skip to content

A wrapper to help you interact with the AzuraCast API using Node.js

License

Notifications You must be signed in to change notification settings

6gh/AzuraCast.js

Repository files navigation

AzuraCast.js

A wrapper to help you interact with the AzuraCast API

Warning

Currently in alpha. Not ready for any deployment

Install

Install with your favorite package manager:

$ npm install azuracast.js # Install with npm
$ pnpm add azuracast.js # Install with pnpm
$ yarn add azuracast.js # Install with yarn

Start by using ES Modules:

import { AzuraCastClient } from "azuracast.js";

Or CommonJS:

const { AzuraCastClient } = require("azuracast.js");

Declare your client:

const client = new AzuraCastClient({
  apiUrl: "YOUR_API_URL",
  apiKey: "YOUR_API_KEY",
});

and start using it!

client.Stations.getAll()
  .then(stations => { ... })
  .catch(err => { ... });

API Coverage

If you'd like to see what API endpoints are currently available to be used with this wrapper, visit the PROGRESS.md file. Currently the project is in alpha so expect there to not be a lot of coverage, or full support.