https://github.com/mannuelf/lastfm-nodejs-client

A Node JS client for interacting with the LastFm API
https://github.com/mannuelf/lastfm-nodejs-client

api api-client lastfm nodejs typescript

Last synced: about 14 hours ago
JSON representation

A Node JS client for interacting with the LastFm API

• Host: GitHub
• URL: https://github.com/mannuelf/lastfm-nodejs-client
• Owner: mannuelf
• License: mit
• Created: 2022-10-28T04:51:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-01T05:04:11.000Z (8 months ago)
• Last Synced: 2025-01-10T15:16:56.934Z (9 days ago)
• Topics: api, api-client, lastfm, nodejs, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/lastfm-nodejs-client
• Size: 450 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# LastFm NodeJs client

[![NPM Version](https://img.shields.io/npm/v/lastfm-nodejs-client.svg?branch=main)](https://www.npmjs.com/package/lastfm-nodejs-client)

[![Downloads Per Week](https://img.shields.io/npm/dw/lastfm-nodejs-client.svg?color=blue)](https://www.npmjs.com/package/lastfm-nodejs-client)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ba3b73c24e06433fabe0efed8b43d026)](https://www.codacy.com/gh/mannuelf/lastfm-nodejs-client/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mannuelf/lastfm-nodejs-client&utm_campaign=Badge_Grade)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A Node JS wrapper client for fetching public data from [LastFm API](https://www.last.fm/api).

Fetch server side or client side, thanks to [cross-fetch](https://github.com/lquixada/cross-fetch)

## How to use the client

Install the npm package in your project.

```bash

pnpm install

```

Consider [PNPM](https://pnpm.io/) ▶️

### Import it

Import the client module:

```js

import { lastFm } from 'lastfm-nodejs-client';

```

Import the Types as type:

```js

import type {

  Artist,

  Track,

  User,

  WeeklyAlbum,

} from 'lastfm-nodejs-client/dist/@types/lastfm.types';

```

_Working on getting these into [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)_

### Use it

```js

const lastFm = LastFmApi();

const { config, method } = lastFm;

const getTopArtists = async () => {

  const data = await lastFm.getTopArtists(

    method.user.top_artists,

    config.username,

    'overall',

    '200',

  );

  const { topartists } = data;

  return topartists;

};

```

🚀 Gives you:

![user](https://res.cloudinary.com/mannuel/image/upload/v1668059500/topartist.png)

## Developing client

Written in TypeScript, compiles down to ES2015, provides the types for the lastFm entities.

## Fork repo

```bash

gh repo fork mannuelf/lastfm-nodejs-client

```

What's gh? [Get it here](https://cli.github.com/manual/gh_repo_fork)

### Postman collections

A list of endpoints currently mapped to this client. Still under development, not feature complete.

[View collections](https://documenter.getpostman.com/view/4217/2s8YKJELqJ) ▶️

### ENV

Create `.env` file in project root:

You do not need an API key to query the public USER entity, add only base url and a username to env file.

```bash

LASTFM_API_BASE_URL=""

LASTFM_USER=""

```

For everything else you will need to include:

```bash

LASTFM_API_KEY=""

LASTFM_APPNAME=""

```

Create them [here](https://www.last.fm/api/account/create).

### Develop

```bash

pnpm test

```

```bash

pnpm lint

pnpm lint-fix

```

### Build

```bash

pnpm build

```

### Publish

```bash

pnpm prepare

pnpm publish

```

### Why I built this?

I was building a scrobbles page [https://mannuelferreira.com/scrobbles](https://mannuelferreira.com/scrobbles) and I thought others might want it to.

### TODO

- move types into [DefinitelyTyped](https://github.com/mannuelf/DefinitelyTyped)