https://github.com/pwaldhauer/dayone

NodeJS Module to create, list and remove Day One Journal entries
https://github.com/pwaldhauer/dayone

Last synced: 2 months ago
JSON representation

NodeJS Module to create, list and remove Day One Journal entries

• Host: GitHub
• URL: https://github.com/pwaldhauer/dayone
• Owner: pwaldhauer
• Created: 2013-06-23T00:49:41.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-06-01T20:44:07.000Z (over 8 years ago)
• Last Synced: 2024-08-09T14:33:07.244Z (5 months ago)
• Language: JavaScript
• Size: 33.2 KB
• Stars: 24
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - pwaldhauer/dayone - NodeJS Module to create, list and remove Day One Journal entries (JavaScript)

README

        
# dayone

NodeJS Module to create, list and remove [Day One](http://dayoneapp.com/) Journal entries, without using the [Day One command line tools](http://dayoneapp.com/tools/).

## Usage

```javascript

var DayOne = require('dayone').DayOne;

var DayOneEntry = require('dayone').DayOneEntry;

// Basic entry

var entry = new DayOneEntry();

entry.creationDate = new Date();

entry.text = 'Very thoughtful entry!';

entry.tags = ['Test'];

// Attach a photo!

var entryWithPhoto = new DayOneEntry();

entryWithPhoto.text = 'Have a photo!';

entryWithPhoto.photo = new Buffer(fs.readFileSync('photo.jpg'));

var dayone = new DayOne();

dayone.save(entry, function(error) {

    console.log('Saved!');

})

```

Optionally `DayOne()` accepts an object containing a `directory` that should point to the Day One Journal directory. If omitted it will use the iCloud documents directory by default. If it doesn't find the iCloud directory, it will use the Dropbox Application directory.

For more usage examples take a look at the tests or [Elizabeth](https://github.com/pwaldhauer/elizabeth), my script to export your Moves.app data, which uses this module. Surprise!

## Methods

### DayOne#list(options, cb)

Lists all entries in the journal. List may be filtered by tags by passing in `{"tags": ["Tags", "to", "filter", "by"]}` as options. The callback should be a `function(err, entries) {}`.

### DayOne#save(entry, cb)

Saves the given `DayOneEntry`. The callback should be a `function(err) {}`.

### DayOne#remove(uuid, cb)

Removes the entry. The callback should be a `function(err) {}`.

### DayOneEntry

Basically an object with the following fields: `creationDate` (Date), `text` (String), `tags` (Array), `timezone` (String), `starred` (Bool), `UUID` (String), `photo` (Buffer). If the `UUID` is not defined it will be automatically created.

## Contribute

Feel free to contribute! :)