Please use the leankoala-gmbh/leankoala-client-typescript TypeScript package instead.
The library is used to communicate with the KoalityEngine.
Please contact [email protected] if you want to use the API.
The KoalityEngine API can return the results in different languages. The preferred language can be defined in the
connect argument or later on via the setLanguage method.
await client.connect({ username: 'demo', password: 'demo', language: 'de' })
// or
client.setLanguage('de')# via username and password
await client.connect({ username: 'demo', password: 'demo', axios })
# via wakeup token
await client.connect({ wakeUpToken, axios })
# via refresh token
await client.connect({ refreshToken, userId, axios })This example returns a list of projects the user demo is part of.
const LeankoalaClient = require('../src/Client');
const axios = require('axios');
(async () => {
const client = new LeankoalaClient('stage')
await client.connect({ username: 'demo', password: 'demo', axios })
const user = client.getUser()
const projectRepository = await client.getRepository('project')
const projects = await projectRepository.search({ user: user.id })
console.log('Projects:', projects)
})()More examples can be found in the examples directory. A good idea could also be having a look at
the test cases in the tests directory.