https://github.com/kcreate/norcal
a web-based calendar that you can sync, link, embed, and edit offline
https://github.com/kcreate/norcal
Last synced: 11 months ago
JSON representation
a web-based calendar that you can sync, link, embed, and edit offline
- Host: GitHub
- URL: https://github.com/kcreate/norcal
- Owner: KCreate
- License: other
- Created: 2016-06-20T19:13:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-20T22:05:49.000Z (over 9 years ago)
- Last Synced: 2025-03-29T11:52:51.812Z (11 months ago)
- Language: JavaScript
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.markdown
- License: LICENSE
Awesome Lists containing this project
README
# norcal
p2p command-line calendar
# usage
```
norcal
Show a calendar and events for the current month.
norcal add TIMESTR {-t TITLE}
Add an event by its TIMESTR with a TITLE.
norcal rm ID
Delete an event by its ID.
norcal query {--gt GT --lt LT}
List events from GT to LT.
```
# api
``` js
var norcal = require('norcal')
```
## var cal = norcal(opts)
Create a new norcal instance `cal` from:
* `opts.log` - hyperlog instance to use
* `opts.db` - leveldb instance to use
## cal.add(time, opts, cb)
Add an event given by a free-form string `time` which is parsed by
[parse-messy-schedule][1]. Optionally:
* `opts.created` - parse relative to this time
* `opts.value` - a value to store alongside the time
`cb(err, node, id)` fires with the underlying hyperlog `node` and the generated
key/value `id`.
[1]: https://npmjs.com/package/parse-messy-schedule
## cal.remove(id, cb)
Remove an event by its `id`.
## var stream = cal.query(opts, cb)
Produce a readable objectMode stream of events in the range given in `opts`:
* `opts.gt` - date instance or string
* `opts.lt` - date instance or string
Each document in the object stream:
* `doc.time` - a Date instance for the event
* `doc.value` - extra properties like a title
* `doc.created` - when this record was created / relative to
* `doc.key` - the id in the underlying key/value store
You can collect all of the documents with `cb(err, docs)`.
# install
To get the command-line tool:
```
npm install -g norcal
```
To get the library:
```
npm install norcal
```
# license
BSD