Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@odit/lfk-client-js

niggl318CC-BY-NC-SA-4.01.2.7TypeScript support: included

A lib to interact with https://git.odit.services/lfk/backend. Use this version for native JS applications.

odit, odit.services, lfk

readme

ODIT.Services - LfK-Client (JS Version)

Build Status

The official library for the LfK backend server. Automagicly™ generated by openapi-typescript-codegen

🛠 Building

Setup ⬇️

git clone https://git.odit.services/lfk/lfk-client-js.git
cd lfk-client-js
pnpm i

Build 🔨

pnpm update:openapi # Update the openapi.json file
pnpm build # Build the project
pnpm release # Bump and release to npm

# Or just do it all in one command
pnpm update:auto

Use

Basic example: Get all tracks

import {OpenAPI, TrackService} from "@odit/lfk-client-js";
OpenAPI.BASE = "https://localhost:4010";
console.log(await TrackService.trackControllerGetAll());

Install

Via yarn/npm:

yarn add @odit/lfk-client-js
# Or
npm i @odit/lfk-client-js

Or just copy the folder dist to your prefered lib folder and import everything you need from dist/index.ts.