Giter Club home page Giter Club logo

wakatimejs's Introduction

wakatimejs

JavaScript library for getting data of the WakaTime API. Currently, you can only retrieve data by using your WakaTime API Key

Install

npm install wakatime

Usage

import {WakaTime} from "wakatime"

Set API Key

const wakaTimeInstance = new WakaTime('API_KEY')

or

const wakaTimeInstance = new WakaTime()
wakaTimeInstance.apiKey = 'API_KEY'

Get API Key

const apiKey = wakaTimeInstance.apiKey
console.log(apiKey) // API_KEY

Get current user

wakaTimeInstance.currentUser()
    .then((resp) => console.log(response))
    .catch((err) => console.log(err))
})

Get stats

A user's logged time for the given time range. Range can be one of:

  • last_7_days
  • last_30_days
  • last_6_months
  • last_year
  • all_time
wakaTimeInstance.stats('last_7_days').then().catch()

Get summaries

A user's logged time for the given time range as an array of summaries segmented by day.

There are four ways to get your WakaTime summaries.

  1. By defining start and end date in YYYY-MM-DD format.

    wakaTimeInstance.summaries({
        start: '2015-10-07',
        end: '2015-10-13'
    }).then().catch()
  2. By defining start and end date in a Date instance.

    wakaTimeInstance.summaries({
        start: new Date(),
        end: new Date()
    }).then().catch()
  3. For single date summary, define the date in YYYY-MM-DD format or use a JS Date.

    wakaTimeInstance.summaries('2015-10-13').then().catch()
    wakaTimeInstance.summaries(new Date()).then().catch()

Get durations

A user's logged time for the given day as an array of duration blocks. There are two days to get durations.

  1. By defining the target date in YYYY-MM-DD format.

    wakaTimeInstance.durations('2015-10-13').then().catch()
  2. By defining the target date in a Date instance.

    wakaTimeInstance.durations(new Date()).then().catch()

Authors

License

MIT

wakatimejs's People

Contributors

alanhamlett avatar jestillore avatar mannil avatar

Watchers

 avatar  avatar

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.