Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.07 KB

readme.md

File metadata and controls

51 lines (32 loc) · 1.07 KB

WakaTimeJS

Type safe JavaScript client for the WakaTime REST API

Installation

npm install wakatimejs

or

yarn add wakatimejs

Usage

consumption is super straight forward, just import the class and instantiate it with your api key.

import { WakaTime } from "wakatimejs"; // or const { WakaTime } = require('wakatimejs');

const wakaTime = new WakaTime("your-api-key");

wakaTime.users.current().then((user) => {
	console.log(user);
});

Alternatively, if you don't have access to the api key at the time of instantiation, you can use the setApiKey method.

import { WakaTime } from "wakatimejs";

const wakatime = new WakaTime();

// ... later on

wakaTime.setApiKey("your-api-key");

wakaTime.users.current().then((user) => {
	console.log(user);
});

API

The API follows the samme nameing convention for the endpoints as the REST API.

some of the routes in the REST API require a user id or authentication, but these are handled by the client, so you don't have to worry about them.