Kindle-Clipping

> kindle-clipping is a minimalist JavaScript library to parse kindle clippings.txt to json, manage your note and highlight.


- 2kb mini library
- 简体中文 / English language support
- find clipping.txt automatically
- note & highlight merge
- clipping string parse

Getting Started

$3

``console
npm install kindle-clipping --save
`

$3

`javascript
import kindleClipping from 'kindle-clipping'

const kindleClipping = require('kindle-clipping')

`

$3

#### init

`javascript
// get kindle clippings.txt by default path
kindleClipping()

// get kindle clippings.txt by custom path, customPath must be an absolute path.
kindleClipping(customPath)// eg. kindleClipping(Path.resolve([path]))
`
#### getJson()
get an array of unprocessed notes and highlight objects
`javascript
// eg.
kindleClipping().getJson()
// [
// {
// bookName: 'a book',
// content: 'excellence—whose greatness',
// type: 'Note',
// page: '37',
// location: '565',
// date: 'Friday, February 19, 2021 6:06:48 PM',
// }
// ]
`
#### getMergedJson()
getMergedJson returns an array of combined notes and annotation objects
`javascript
// eg.
kindleClipping().getMergedJson()
// [
// {
// bookName: 'Mindset (Carol Dweck)',
// content: 'excellence—whose greatness',
// type: 'Note',
// page: '37',
// location: '565',
// date: 'Friday, February 19, 2021 6:06:48 PM',
// note: 'is a note',
// content: 'highlight content'
// }
// ]
`

#### clippingParser(clippingString)
parses clipping string to a nested array of note and highlight
`javascript
// eg.
let clippingString = Mindset (Carol Dweck)
- Your Highlight on page 37 | Location 565-565 | Added on Friday, February 19, 2021 6:06:48 PM

As a contrast, let’s look
==========
Mindset (Carol Dweck)
- Your Note on page 37 | Location 565-565 | Added on Friday, February 19, 2021 6:06:48 PM

excellence—whose greatness
==========

kindleClipping.clippingParser(clippingString)
// [
// {
// bookName: 'Mindset (Carol Dweck)',
// content: 'As a contrast, let’s look',
// type: 'Highlight',
// page: '37',
// location: '565',
// date: 'Friday, February 19, 2021 6:06:48 PM'
// },
// {
// bookName: 'Mindset (Carol Dweck)',
// content: 'excellence—whose greatness',
// type: 'Note',
// page: '37',
// location: '565',
// date: 'Friday, February 19, 2021 6:06:48 PM'
// }
// ]
``

License

kindle-clipping is licensed under a MIT License.