https://github.com/bkper/bkper-api-types
Typescript definitions for the Bkper REST API
https://github.com/bkper/bkper-api-types
Last synced: 5 months ago
JSON representation
Typescript definitions for the Bkper REST API
- Host: GitHub
- URL: https://github.com/bkper/bkper-api-types
- Owner: bkper
- License: mit
- Created: 2020-08-06T13:24:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-13T11:05:17.000Z (5 months ago)
- Last Synced: 2026-01-13T14:13:29.853Z (5 months ago)
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Summary
This package contains Typescript definitions for the [Bkper REST API](https://bkper.com/docs/#rest-api).
[](https://www.npmjs.com/package/@bkper/bkper-api-types)
The types are generated based on the Bkper [Open API spec](https://bkper.com/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
More information at the [Bkper Developer Documentation](http://bkper.com/docs/#rest-api)
# Instalation
### 1) Add the package:
```
npm i -S @bkper/bkper-api-types
```
or
```
yarn add --dev @bkper/bkper-api-types
```
### 2) Configure tsconfig.json:
```
{
"compilerOptions": {
"typeRoots" : ["node_modules/@bkper", "node_modules/@types" ]
}
}
```
[Learn more](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types) about **@types**, **typeRoots** and **types**