Skip to content

Repository files navigation

LRCLIB API

TypeScript libraries for reading and parsing lyrics from LRCLIB.

Packages

Package Purpose
lrclib-api Type-safe API client and LRC parser for Node.js and browsers
@lrclib-api/react React provider and hooks built on lrclib-api

Quick start

npm install lrclib-api
import { Client } from "lrclib-api";

const client = new Client();
const lyrics = await client.findLyrics({
  track_name: "The Chain",
  artist_name: "Fleetwood Mac",
});

console.log(lyrics.plainLyrics);

See the lrclib-api documentation for all client methods and parsing helpers.

Development

The repository requires Node.js 20 or newer.

npm ci
npm run check

npm run check runs formatting/lint checks, TypeScript validation, deterministic unit tests, and production builds for every workspace.

Security

Please report vulnerabilities privately according to the security policy. Do not include tokens or private lyrics in issues, logs, or test fixtures.

License

ISC © Igor Figueiredo. See LICENSE.

About

The unofficial lrclib.net library for JS and TS

Topics

Resources

Code of conduct

Security policy

Stars

11 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages