Skip to content

🎧 A simple, asynchronous Last.fm library written in TypeScript.

License

Notifications You must be signed in to change notification settings

SapphicMoe/simple-fm

Repository files navigation

Headphones with musical notes coming out of it.

simple-fm

A simple, asynchronous Last.fm wrapper in TypeScript.

Search for what someone has been listening to lately, what tracks are trending in a country, an artist's top tracks, and a lot more.

For more information, please visit the documentation website.

CI npm-image downloads-image license-image

Install

simple-fm requires that you have Node.js 18 (and above) and TypeScript v5+ installed.

  • npm: npm i @solely/simple-fm
  • pnpm: pnpm i @solely/simple-fm
  • yarn: yarn add @solely/simple-fm
  • bun: bun i @solely/simple-fm

Notice

simple-fm requires you to have a Last.fm API key.

To obtain a Last.fm API key, click here to register an API account.

Example usage

// Import the simple-fm package.
import SimpleFM from '@solely/simple-fm'; // ESM
import SimpleFM from 'https://esm.sh/@solely/simple-fm'; // Deno
const SimpleFM = require('@solely/simple-fm'); // CommonJS
// Replace the token with your Last.fm API key.
const client = new SimpleFM('Last.fm API key');

// Fetch the recent track from a user.
const json = await client.user.getRecentTracks({ username: 'solelychloe' });

console.log(json);

License

This package is licensed under the zlib license.

© 2024 Chloe Arciniega.