@musicplayce/ts-sdk

MusicPlayce SDK made with Typescript intended for client & server-side use.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Getting Started
  • Installing
  • Usage
• Built With
• Versioning
• Author(s)
• License

Getting Started

Installing

Using npm:

npm install @musicplayce/ts-sdk

Using yarn:

yarn add @musicplayce/ts-sdk

Usage

Import the SDK into your project:

import MPlayceClient from '@musicplayce/ts-sdk';

// or use require
const MPlayceClient = require('@musicplayce/ts-sdk');

Initialize a new client:

const options = { beta: true }; // Passing an options object is optional!
const client = new MPlayceClient(options).authenticate({ username: 'YOUR_USERNAME_EMAIL_HERE', password: 'YOUR_PASSWORD_HERE' });

console.log(client.apiVersion); // '1.0'

Built With

• Typescript - Typescript enables JavaScript developers to use highly-productive development tools and practices like static checking and code refactoring when developing JavaScript applications.
• Axios - Promise based HTTP client for the browser and node.js.
• lodash - A modern JavaScript utility library delivering modularity, performance, & extras.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author(s)

• Gustavo Quinta - Initial work - MoonTory

License

This project is licensed under the MIT License - see the LICENSE.md file for details