Giter Club home page Giter Club logo

spotify-search-tag-parser's Introduction

Spotify Search Tag Parser

This is a Spotify search tag parser. It does extract or remove search tags from a text.

NPM

Table of contents

Features

The library includes functions to do the following:

- Remove Spotify search tags from text
- Extract Spotify search tags from text

Installation

$ npm install spotify-search-tag-parser --save

Usage

First, instantiate.

var SpotifySearchTagParser = require("spotify-search-tag-parser");

var spotifySearchTagParser = new SpotifySearchTagParser();

Lastly, use the spotifySearchTagParser object's methods to remove or extract spotify search tags.

// remove artist tag from text
let result = spotifySearchTagParser.removeSpotifySearchTag(
  "album: inhale/exhale artist: nasum",
  SpotifySearchTagParser.spotifySearchTags.ARTIST
);

Spotify Search Tags

  • artist
  • album
  • track
  • label
  • isrc
  • upc
  • year
  • tag

Separator

Its necessary to include a ; separator in text when there is no spotify tag separator, examples:

  • artist: Guns N' Roses; Appetite for Destruction
  • artist: Guns N' Roses album: Appetite for Destruction; 1987

Extract Spotify search tags result

When extracting search tags the parser gonna return:

  • text: matched text
  • tagValue: matched tag value in text
  • tag: matched tag type

Example:

var result = spotifySearchTagParser.getSpotifySearchTagMatches(
  "album:inhale/exhale artist:nasum year:1998"
);

Result:

[
  {
    text: "artist:nasum ",
    tagValue: "nasum",
    tag: "artist",
  },
  {
    text: "album:inhale/exhale ",
    tagValue: "inhale/exhale",
    tag: "album",
  },
  {
    text: "year:1998",
    tagValue: "1998",
    tag: "year",
  },
];

Functions

Below are examples for all functions.

var SpotifySearchTagParser = require("spotify-search-tag-parser");
var spotifySearchTagParser = new SpotifySearchTagParser();

/**
 * Remove Tag Functions
 */

// Remove specific tag, album one
var result = spotifySearchTagParser.removeSpotifySearchTag(
  "album: inhale/exhale ; nasum",
  SpotifySearchTagParser.spotifySearchTags.ALBUM
);

// Remove every tag
var result = spotifySearchTagParser.removeSpotifySearchTags(
  "artist: nasum album:inhale/exhale year:1998"
);

/**
 * Extract Tag Functions
 */

// Extract only one tag
var result = spotifySearchTagParser.getSpotifySearchTagMatch(
  "album:inhale/exhale artist:nasum year:1998",
  SpotifySearchTagParser.spotifySearchTags.ARTIST
);

// Extract every tag
var result = spotifySearchTagParser.getSpotifySearchTagMatches(
  "album:inhale/exhale artist:nasum year:1998"
);

spotify-search-tag-parser's People

Contributors

thiagorizzo 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.