Skip to content
Fitbit TypeScript definitions for your projects
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.
doc/img
scripts
test-code-samples
types
.gitignore
.npmignore
.prettierrc
.travis.yml
LICENSE
README.md
package-lock.json
package.json

README.md

Fitbit SDK Types ✔

npm version Build Status

Add types to your Fitbit CLI project and work safely with TypeScript preventing you of doing stupid mistakes.

⚙ How to use in your app project

  1. First, create your Fitbit CLI project following the official instructions at https://dev.fitbit.com/build/guides/command-line-interface/.
  2. Then, from that project root, run npx fitbit-sdk-types apply to apply TypeScript to your existing Fitbit project.

You can also do it manually wit the following basic configuration files:

  • app/tsconfig.json
{
	"extends": "../tsconfig.json",
	"include": ["**/*.ts", "../node_modules/fitbit-sdk-types/types/device"]
}
  • companion/tsconfig.json
{
	"extends": "../tsconfig.json",
	"include": ["**/*.ts", "../node_modules/fitbit-sdk-types/types/companion"]
}
  • settings/tsconfig.json
{
	"extends": "../tsconfig.json",
	"include": [
		"**/*.ts",
		"**/*.tsx",
		"../node_modules/fitbit-sdk-types/types/settings"
	]
}
  • tsconfig.json:
{
	"extends": "./node_modules/@fitbit/sdk/sdk-tsconfig.json"
}

Benefits of using types

Discoverability

Know what is available to build your ideas right from your code.

Enumerated and strict string literals

Autocomplete permissions

Also in JSX for settings

Autocomplete in JSX

Integrated with the Fitbit CLI build process

It is fully integrated within the Fitbit CLI build process that already uses TypeScript. With this approach you are just extending its knowledge about what can you use and how.

So if your code is not ok, then it won't build. That way it will prevent you from wasting a lot of time with typos, undefined functions and trivial bugs, letting you focus on what really matters.

Code error, so the build process fails Build integration

Examples

You can see a ton of official examples working as tests right here, under the ./test-code-samples path.

Gotchas

Be strict...

  • 🧐 To have a full type experience: add the strict mode to your tsconfig.json:
{
	"compilerOptions": {
		"strict": true
	}
}

... Or not

You can always place // @ts-ignore right above that line of code that you know that should work, and probably needs to have it's typings fixed.

SDK Support

Only the latest SDK version is supported. Also don't expect this project version to match the official SDK version.

Contributing

❗ Open an issue

If you have a question, suggestion or bug report, don't be shy and open an issue 🎈.

💪 Make a PR

  1. The use cases you think that must be covered, under a meaningful section inside test-code-samples/.
  2. The type definition in the appropiate types/ file.
  3. If possible, a link to the official documentation or community forum thread.
You can’t perform that action at this time.