Giter Club home page Giter Club logo

tog's Introduction

Modern Toggl API wrapper and Timer.

This package wraps the Toggl API with a promised based approach. This makes the usage of async/await straight forward.

It also has timer functionality build in to easily start, stop and update the a time entry.

Build Status

Requirements

This package requires node 8 or higher, because of async/await usage.

Installation

npm install tog

Usage

Initialisation

import { Toggl } from 'tog'

// Using your API token
const toggl = new Toggl({ apiToken: 'YOUR_API_TOKEN' })

// Using your credentials
const toggl = new Toggl({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
})

Getting data

const { data: clients } = await toggl.getClients(workspaceId)

Using a timer

// Starting a timer
const timer = await toggl.startTimer({ description: 'I\'m very busy' })

// Updating the time entry
await timer.update({ description: 'Still very busy' })

// When you're done
await timer.stop()

// Get details of the timer
console.log(timer.entry)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.