netscape-bookmark-export-converter/README.md

Converts Netscape Bookmark Format files used by popular web browsers to an array of objects containing individual bookmarks URI's and their respective folder tags.

# netscape-bookmark-export-converter
 Converts Netscape Bookmark Format files used by popular web browsers to an array of objects containing individual bookmarks URI's and their respective folder tags.

## Features
* Easily converts Netscape Bookmarks Format files to an array of objects
* Bookmark folders are converted to tags which can be used to maintain and manage categorization

## Compatability
* Google Chrome Bookmarks
* Microsoft Edge Favorites
* Mozilla Firefox
* Apple Safari
* Opera Browser

## Installation
```sh
npm install netscape-bookmark-export-converter
```
or

```sh
yarn add netscape-bookmark-export-converter
```

## Usage

#### TypeScript
```ts
import { convert } from 'netscape-bookmark-export-converter';
import { join } from 'path';

interface Bookmark {
    url: string;
    tags: string[];
}

const convertFileToBookmarkArray = async (bookmarksFilePath) => {
    // Convert File to Bookmarks Array
    const bookmarks: Bookmark[] = await convert(bookmarksFilePath);

    // Do something with the Bookmarks
    console.log(bookmarks);
}

const bookmarksFilePath: string = join(__dirname, "bookmarks.html");
convertFileToBookmarkArray(bookmarksFilePath);
```
#### JavaScript

```js
const convert = require('netscape-bookmark-export-converter').convert;
const path = require('path');

const convertFileToBookmarkArray = async (bookmarksFilePath) => {
    // Convert File to Bookmarks Array
    const bookmarks = await convert(bookmarksFilePath);

    // Do something with the Bookmarks
    console.log(bookmarks);
}

const bookmarksFilePath = path.join(__dirname, "bookmarks.html");
convertFileToBookmarkArray(bookmarksFilePath);
```

#### Example Output
```
[
    { url: 'http://example.com/', tags: [ 'Favorites bar' ] },
    {
        url: 'https://www.google.com/',
        tags: [ 'Favorites bar', 'Search' ]
    },
    { url: 'https://www.theverge.com/tech', tags: [ 'Favorites bar' ] },
    { url: 'https://www.tudublin.ie/', tags: [ 'Favorites bar' ] },
    { url: 'https://www.imdb.com/', tags: [ 'Favorites bar', 'Movies' ] },
    {
        url: 'https://www.imdb.com/title/tt0111161/?ref_=nv_sr_srsg_0',
        tags: [ 'Favorites bar', 'Movies', 'Best' ]
    }
]
```

## Testing
```sh
npm run test
```
or
```sh
yarn test
```