https://github.com/jeremyjeanson/fitfont-types

Types definitions to use fitfont with TypeScript
https://github.com/jeremyjeanson/fitfont-types

fitbit fitbitdev

Last synced: about 2 months ago
JSON representation

Types definitions to use fitfont with TypeScript

• Host: GitHub
• URL: https://github.com/jeremyjeanson/fitfont-types
• Owner: JeremyJeanson
• License: mit
• Created: 2020-10-02T21:14:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-10-04T21:50:10.000Z (over 4 years ago)
• Last Synced: 2024-10-11T09:28:45.166Z (3 months ago)
• Topics: fitbit, fitbitdev
• Homepage:
• Size: 98.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/dw/fitfont-types.svg?logo=npm&label=npm%20version)](https://www.npmjs.com/package/fitfont-types)

# Introduction

This package include Types definitions to use [fitfont](https://github.com/gregoiresage/fitfont) with TypeScript.

Types have comments to allow developers to view documentation in Visual Studio Code.

# Installation

## 1. Install the module

You could use a any package manager to install this module. It was tested with npm, yarn and pnpm.

```sh

npm install fitfont-types --save-dev

```

## 2. Include types in your projects

Update the `tsconfig.json` inside the app folder. Add `"../node_modules/fitfont-types/types"`  to paths to include.

```json

{

 "extends": "../tsconfig.json",

 "include": [

  "**/*.ts",

  "../node_modules/fitbit-sdk-types/types/device",

  "../node_modules/fitfont-types/types"

 ]

}

```