tyler.durden/d-fi-core
1
0
Fork 0
mirror of https://github.com/d-fi/d-fi-core.git synced 2025-07-24 06:05:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

add parse docs

Browse Source
This commit is contained in:
Sayem Chowdhury 2021-03-24 12:38:45 +06:00
parent 11900bda8b
commit af63785642
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/parse.md Normal file
View File

@ -0,0 +1,17 @@
## Parse
Parse Deezer, Spotify and Tidal URLs to downloadable data.
## Usage
`parseInfo` parses information as json data. Throws `Error`, make sure to catch error on your side.
```ts
import {parseInfo} from 'd-fi-core';
// Get link information
const info = await parseInfo(url);
console.log(info);
```
Please take a look at [`src/converter/parse.ts`](https://github.com/d-fi/d-fi-core/blob/master/src/converter/parse.ts) and [`__tests__/converter/parse.ts`](https://github.com/d-fi/d-fi-core/blob/master/__tests__/converter/parse.ts) to understand more.