/node-timetrap_wraplib

Node.js wrapper library for the Timetrap command line ruby application.

Primary LanguageJavaScriptMIT LicenseMIT

Build Status npm version issues license

Project: Timetrap wrapper lib for node.js

Author: Karl N. Redman

This is a wrapper library for the Timetrap command line ruby application. The library offers an api for synchronous and asynchronous timetrap system calls.

Note:

This library is a work in progress. More info soon.

Requirements:

  • Linux (currently)
  • Node.js v8.4+
  • a running Timetrap installation with some data

Features

Upcoming Features:

  • better documentation
  • commands:
    • kill
    • move
    • archive

Installation:

Example Configuration / Usage:

Configuration:

  • examples/Timetrap.example.js
    1. in function main specify the database file to watch
      • ...if you want to run the database file monitoring functionality
    2. uncomment the code you want to run
    3. run the example
     node ./Timetrap.example.js
    

API Documentation:

F.A.Q:

Thank You and Credit To:

  • The author and contributors of the Timetrap project for an elegant and useful time keeping solution.
  • The community at StackOverFlow.
  • Node.js contributors.
  • jest contributors.