Skip to content
Pomodoro timer construct
JavaScript HTML CSS Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
dist
out
scripts
spec
src
.babelrc
.eslintignore
.gitignore
.travis.yml
README.md
bower.json
gulpfile.js
package.json
testem.json

README.md

Build Status npm version

Pomodoro

A pomodoro timer in pure JavaScript.

Installation

Available through npm as ptimer.

npm install ptimer

add a require to your js

const Pomodoro = require('ptimer');

Usage

Creating a General Timer

const pomodoro = new Pomodoro(taskDuration, breakDuration);

API

For the full API view the documentation.

.startTask(callback)

Must be executed to start the task timer, executing the passed callback at every execution.

.startBreak(callback)

Must be executed to start the break timer, executing the passed callback at every execution. The condition is that the taskTimer is at 0 duration. Beginning from the duration down to 0.

.taskDuration()

Gets the current duration of the task timer.

.breakDuration()

Gets the current duration of the break timer.

License

The MIT License (MIT)

Copyright (c) 2016 Skyler Layne

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.