README.md

Deprecation notice

Deprecation notice: This project and codebase are not maintained. We might revisit this again in the future, but for now the code is read-only :)

Parser

A parser to take strings that look like "May 4 2-4pm I did some #stuff" and parse out all the useful information like start/end time, date, tags, etc. into an object.

Install

npm install tickbin-parser

Usage

import { Entry, parser } from 'tickbin-parser'

//  userId may be undefined if you don't wish to associate entry with user
const entry = new Entry(userId, 'May 4 2-4pm I did some #stuff')
//  entry = {
//    version: 6,
//    user: undefined,
//    _id: 'H1yifd_4',
//    original: 'May 4 2-4pm I did some #stuff',
//    message: 'I did some #stuff',
//    ref: Fri Jun 10 2016 10:02:14 GMT-0700 (PDT),
//    hasDates: true,
//    start: Wed May 04 2016 14:00:00 GMT-0700 (PDT),
//    startArr: [ 2016, 4, 4, 14, 0, 0, 0 ],
//    end: Wed May 04 2016 16:00:00 GMT-0700 (PDT),
//    endArr: [ 2016, 4, 4, 16, 0, 0, 0 ],
//    time: 'May 4 2-4pm',
//    duration: {
//      [Number: 7200000]
//      from: Wed May 04 2016 14:00:00 GMT-0700 (PDT),
//      to: Wed May 04 2016 16:00:00 GMT-0700 (PDT)
//    },
//    tags: Set { '#stuff' }
//  }

const parse = parser('8am-10am test message')
//  parse = {
//    start: Thu Jul 21 2016 08:00:00 GMT-0700 (PDT),
//    end: Thu Jul 21 2016 10:00:00 GMT-0700 (PDT),
//    text: '8am-10am',
//    message: 'test message',
//    isRange: true
//  }

Building

npm install
npm run build
npm test

Lead Maintainer: Chad Fawcett