Code Monkey home page Code Monkey logo

tkaraoke-lyrics-searcher's Introduction

I love karaoke

Tkaraoke Lyrics Searcher

Simple module to search for lyrics of a song in the Tkaraoke database. Which mostly useful for Vietnamese songs.

Usage

Install the module:

npm i tkaraoke-lyrics-searcher

Then use it in your code:

import { searchSongLyrics, searchLyricsByLyrics } from 'tkaraoke-lyrics-searcher';

// Search for lyrics by song name
const lyrics1 = searchLyricsBySong("Chuyện nhỏ");
// Search for lyrics by song name and singer
const lyrics2 = searchLyricsBySong("Anh", "Mỹ Lệ");
// Search for lyrics by song name and singer 2
const lyrics3 = searchLyricsBySong("Anh", "Hồ Quỳnh Hương");
// Search for lyrics by song and multiple singers
const lyrics4 = searchLyricsBySong("Nơi Ấy", ["Phan Đinh Tùng", "Hà Okio"]);

console.log(await lyrics1, "\n");
console.log(await lyrics2, "\n");
console.log(await lyrics3, "\n");

// Result:
// Chuyện Nhỏ
// Lê Minh

// Có những lúc chuyện nhỏ tưởng như là khó
// có những lúc thấy lo nhưng mọi chuyện lại chẳng nhằm nhò
// ...
// ...
// Anh
// Nguyễn Hoài Anh

// Anh vẫn đến dù trời gió mưa giăng khắp lối
// Dù cho những lúc giá rét suốt đêm mùa đông lạnh lùng
// ...
// ...
// Anh
// Xuân Phương

// Một lời anh không muốn nói
// là một mai hai ta không cách xa
// ...
// ...
// Nơi Ấy
// Nguyễn Hải Phong

// Có lắm lúc nắng chói quanh ta con đường hàng cây xanh lá
// Những góc phố sớm tối đi qua thơm ngát quá...

const lyrics4 = searchLyricsByLyrics("Mùa đông trên thung lũng xa");
const lyrics5 = searchLyricsByLyrics("Phố sương mù, phố chưa lên đèn");

console.log(await lyrics4, "\n");
console.log(await lyrics5, "\n");

// Result:
// Chiếc Lá Mùa Đông
// Nhạc Ngoại [Lời Việt: Khúc Lan]

// Mùa đông trên thung lũng xa
// như một tiếng kinh cầu
// Làm sao để ta quên đi một cơn bão lớn
// ...
// ...
// Phố Mùa Đông
// Bảo Chấn

// Phố sương mù, phố chưa lên đèn
// Núi quanh đồi như mùa trăng cũ
// Từng dốc phố, quấn quanh núi đồi

OR, with CommonJS:

const ts = require("tkaraoke-lyrics-searcher");
const test = async () => {
  const lyrics1 = await ts.searchLyricsBySong("Chuyện nhỏ");
  console.log(lyrics1, "\n");
};

test();

// Result:
// Chuyện Nhỏ
// Lê Minh

// Có những lúc chuyện nhỏ tưởng như là khó
// có những lúc thấy lo nhưng mọi chuyện lại chẳng nhằm nhò

Notes

The lyrics content is belong to the Tkaraoke database, and the module only search for the lyrics in the database.

The lyrics content is not guaranteed to be accurate, it could be wrong about the writer, the singer, or the lyrics itself.

License

The MIT License (MIT)

Copyright (c) 2024 Vuong Bui

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tkaraoke-lyrics-searcher's People

Contributors

vuon9 avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.