Skip to content

vookav2/songlyrics

Repository files navigation

songlyrics

Search a lyrics. It scrapes the lyrics from unofficial sources.

Donate Donate

Codefactor Latest version Monthly downloads

Table of contents
  1. Getting Started
  2. Usage
  3. Contributing
  4. Disclaimer
  5. Support
  6. License

Getting Started

Prerequisites

  • Node.js v16 or greater
    node --version
    

Installation

  • NPM
    npm install songlyrics
  • Yarn
    yarn add songlyrics

Usage

Import functions that you need.

import songlyrics from 'songlyrics'
const response = await songlyrics('one more light')

// with artist name
const response = await songlyrics('one more light linkin park')

Output

Lyrics

{
  lyrics: string,
  source: {
    name: string,
    url: string,
    link: string,
  },
}

Contributing

Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.

Support

Give a 🌟 star if this project is useful to you.

Disclaimer

This project is not affiliated with, endorsed, or sponsored by YouTube or any of their affiliates or subsidiaries. All trademarks, logos and brand names are the property of their respective owners, and are used only to directly describe the services being provided, as such, any usage of trademarks to refer to such services is considered nominative use.

Should you have any questions or concerns please contact me directly via email.

License

Distributed under the MIT License.

(⬆ back to top)