This repository has been archived on 2023-11-06. You can view files and clone it, but cannot push or open issues or pull requests.
2020-12-22 14:22:57 +00:00
|
|
|
# ODIT.Services - LfK-Client (Node Version)
|
2020-12-29 13:29:15 +00:00
|
|
|
|
2020-12-22 14:49:25 +00:00
|
|
|
[](https://ci.odit.services/lfk/lfk-client-node)
|
|
|
|
|
|
2020-12-13 08:40:46 +00:00
|
|
|
The official library for the LfK [backend server](https://git.odit.services/lfk/backend).
|
|
|
|
|
Automagicly™ generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen)
|
2020-12-12 21:24:45 +00:00
|
|
|
|
2020-12-13 08:40:46 +00:00
|
|
|
## 🛠 Building
|
|
|
|
|
Get's automagicly™ build by drone for every new backend release.
|
|
|
|
|
|
|
|
|
|
## Use
|
|
|
|
|
|
|
|
|
|
Basic example: Get all tracks
|
|
|
|
|
```typescript
|
2020-12-22 14:22:57 +00:00
|
|
|
import {OpenAPI, TrackService} from "@odit/lfk-client-node";
|
2020-12-13 08:40:46 +00:00
|
|
|
OpenAPI.BASE = "https://localhost:4010";
|
|
|
|
|
console.log(await TrackService.trackControllerGetAll());
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Install
|
|
|
|
|
|
|
|
|
|
Via yarn/npm:
|
|
|
|
|
```bash
|
2020-12-22 14:22:57 +00:00
|
|
|
yarn add @odit/lfk-client-node
|
2020-12-13 08:40:46 +00:00
|
|
|
# Or
|
2020-12-22 14:22:57 +00:00
|
|
|
npm i @odit/lfk-client-node
|
2020-12-13 08:40:46 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or just copy the folder `dist` to your prefered lib folder and import everything you need from `dist/index.ts`.
|
