https://github.com/niksy/read-safari-reading-list

Read and parse Safari Reading List.
https://github.com/niksy/read-safari-reading-list

Last synced: about 2 months ago
JSON representation

Read and parse Safari Reading List.

• Host: GitHub
• URL: https://github.com/niksy/read-safari-reading-list
• Owner: niksy
• License: mit
• Created: 2016-08-14T05:46:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-15T18:33:10.000Z (over 4 years ago)
• Last Synced: 2024-10-18T03:48:33.766Z (2 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# read-safari-reading-list

[![Build Status][ci-img]][ci]

Read and parse Safari Reading List.

## Install

```sh

npm install read-safari-reading-list --save

```

## Usage

```js

import readList from 'read-safari-reading-list';

(async () => {

	const json = await readList('./Bookmarks.plist');

	console.log(json);

	/* [

		{

			"title": "https://www.npmjs.com/package/axe-core",

			"description": "Accessibility engine for automated Web UI testing",

			"url": "https://www.npmjs.com/package/axe-core",

			"dateAdded": "2016-07-31T09:11:41.000Z"

		},

		{

			"title": "“Array” Methods",

			"description": "_.chunk(array, [size=1]) # Ⓢ Ⓝ Creates an array of elements ...",

			"url": "https://lodash.com/docs",

			"dateAdded": "2016-07-31T12:36:22.000Z"

		},

		...

	] */

})();

```

## API

### readList(filePath)

Returns: `Promise`

Reads and parses Safari Reading List binary property list (or any property list

containing Reading List items).

#### filePath

Type: `String`  

Default: `~/Library/Safari/Bookmarks.plist`

Path to property list.

## License

MIT © [Ivan Nikolić](http://ivannikolic.com)

[ci]: https://travis-ci.org/niksy/read-safari-reading-list

[ci-img]: https://img.shields.io/travis/niksy/read-safari-reading-list.svg