Package Exports

nuxtify-api
nuxtify-api/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nuxtify-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Nuxtify API

Lightweight music API for client without third-party libraries.

⚠️ API from ZingMP3

Installation

npm i nuxtify-api
#or
yarn add nuxtify-api

import { Nuxtify } from "nuxtify-api"
#or
const { Nuxtify } = require("nuxtify-api")

Usage

Home

Nuxtify.getHome();

Top 100

Nuxtify.getTop100();

Genres

Nuxtify.getGenres();

Artist

// alias: string
Nuxtify.getArtist('Alan-Walker');

Playlist

// id: string
Nuxtify.getPlaylist('6B8E67CU');

Song

Lyrics

// id: string
Nuxtify.song.getLyrics('Z6709W0Z');

Song URL

// id: string
Nuxtify.song.getUrl('Z6709W0Z');

Song Detail

// id: string
Nuxtify.song.getDetail('Z6709W0Z');

Chart

Home Chart

Nuxtify.chart.getHome();

New Release Chart

Nuxtify.chart.getNewRelease();

Week Chart

// nation: 'vn' | 'kr' | 'us'
// week: number (option)
// year: number (option)
Nuxtify.chart.getWeekly({
  nation: 'vn',
  week: 10,
  year: 2023,
});

Video

Video Detail

// id: string
Nuxtify.video.getDetail('ZWABOA0F');

// id: string
Nuxtify.video.getRelatedVideos('ZWABOA0F');

Search

All Result

// q: string
Nuxtify.search.getResult('faded');

Result by type

// q: string
// type: 'video' | 'song' | 'artist' | 'playlist'
// page: number (option)
Nuxtify.search.getResultByType({
  q: 'faded',
  type: 'song',
  page: 1,
});

Suggestion

Nuxtify.search.getSuggestion('faded');

Nuxtify.search.getRecommendKeyword();

Podcast

All Podcast

Nuxtify.podcast.getAll();

Home Podcast

Nuxtify.podcast.getHome();

Top Podcast

Nuxtify.podcast.getTop();

Podcast URL

// id: string
Nuxtify.podcast.getUrl('Z6AFI0IZ');

Current Playing

// id: string
Nuxtify.podcast.getCurrentMedia('Z6AFI0IZ');

Podcast Detail

// id: string
Nuxtify.podcast.getDetail('Z6AFI0IZ');

Podcast Comments

// id: string
Nuxtify.podcast.getComments('Z6AFI0IZ');

nuxtify-api