From af63785642f7e580d4ecd794c7ddd5c5225fe4fd Mon Sep 17 00:00:00 2001 From: Sayem Chowdhury Date: Wed, 24 Mar 2021 12:38:45 +0600 Subject: [PATCH] add parse docs --- docs/parse.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/parse.md diff --git a/docs/parse.md b/docs/parse.md new file mode 100644 index 0000000..dd07d85 --- /dev/null +++ b/docs/parse.md @@ -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.