https://github.com/sapphicmoe/simple-fm
🎧 A simple, asynchronous Last.fm library written in TypeScript.
https://github.com/sapphicmoe/simple-fm
last-fm last-fm-api lastfm lastfm-api node nodejs typescript
Last synced: 5 months ago
JSON representation
🎧 A simple, asynchronous Last.fm library written in TypeScript.
- Host: GitHub
- URL: https://github.com/sapphicmoe/simple-fm
- Owner: SapphicMoe
- License: zlib
- Created: 2023-02-10T15:21:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T18:04:32.000Z (over 1 year ago)
- Last Synced: 2024-11-19T11:01:12.645Z (11 months ago)
- Topics: last-fm, last-fm-api, lastfm, lastfm-api, node, nodejs, typescript
- Language: TypeScript
- Homepage: https://simple.arciniega.one
- Size: 2.57 MB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## 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][docs].
[![CI][actions-image]][actions-link] [![npm-image]][npm-link] [![downloads-image]][npm-link] [![license-image]][license]
# 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][last-fm-api].
# Example usage
```ts
// 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
```
```ts
// 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] license.
© 2024 Chloe Arciniega.
[actions-image]:
https://img.shields.io/github/actions/workflow/status/SapphicMoe/simple-fm/main.yml?colorA=18181B&colorB=de3931
[actions-link]: https://github.com/SapphicMoe/simple-fm/actions/workflows/main.yml
[docs]: https://simple.sapphic.moe
[logo]: /public/logo.svg 'The Twitter headphone emoji with musical notes in it.'
[license]: /LICENSE
[downloads-image]: https://img.shields.io/npm/dm/@solely/simple-fm.svg?style=flat&colorA=18181B&colorB=de3931
[last-fm-api]: https://www.last.fm/api/account/create
[license-image]: https://img.shields.io/npm/l/@solely/simple-fm.svg?style=flat&colorA=18181B&colorB=de3931
[npm-image]: https://img.shields.io/npm/v/@solely/simple-fm.svg?style=flat&colorA=18181B&colorB=de3931
[npm-link]: https://npmjs.org/package/@solely/simple-fm