node-lokalise-api
Simple NodeJS wrapper around Lokalise service.
Localise API documentation can be found here
Detail package documentation can be found here
- Install
- Usage
- API
- Development
- License
- Support
Install
Install package as yet another npm library with command:
npm install node-lokalise-api
Also you can use another package manager, for example yarn:
yarn add node-lokalise-api
Usage
Include in your module:
const LokaliseAPI = ; const api = token: '<your-lokalise-api-token>'; // get comments for your projectconst result = await apicomments;
Avaiable options are:
token
- access token for Lokalizetimeout
- maximum allowed time for request in millieconds. (10000 by default)retry
- number of allowed retry attempts for failed requests. (2 by default)baseUrl
- base url for Lokalize API endpoints. By default it is https://api.lokalise.co/api2.
API
Comments
List project comments
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicomments;
List key comments
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicomments;
Create comments
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicomments;
Retrieve a comment
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicomments;
Delete a comment
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicomments;
Contributors
List all contributors
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicontributors;
Create contributors
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicontributors;
Retrieve a contributor
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicontributors;
Update a contributor
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicontributors;
Delete a contributor
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apicontributors;
Files
List all files
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apifiles;
Upload a file
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apifiles;
Download files
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apifiles;
Keys
List all keys
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Create keys
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Retrieve a key
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Update a key
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Bulk update
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Delete multiple keys
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Delete a key
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apikeys;
Languages
List system languages
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
List project languages
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
Create languages
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
Retrieve a language
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
Update a language
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
Delete a language
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apilanguages;
Projects
List all projects
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Create a project
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Retrieve a project
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Update a project
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Empty a project
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Delete a project
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiprojects;
Screenshots
List all screenshots
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiscreenshots;
Create screenshots
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiscreenshots;
Retrieve a screenshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiscreenshots;
Update a screenshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiscreenshots;
Delete a screenshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiscreenshots;
Snapshots
List all snapshots
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apisnapshots;
Create a snapshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apisnapshots;
Restore a snapshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apisnapshots;
Delete a snapshot
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apisnapshots;
Tasks
List all tasks
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitasks;
Create a task
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitasks;
Retrieve a task
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitasks;
Update a task
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitasks;
Delete a task
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitasks;
Team Users
List all team users
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiteamUsers;
Retrieve a team user
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiteamUsers;
Update a team user
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiteamUsers;
Delete a team user
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiteamUsers;
Teams
List all teams
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apiteams;
Translations
List all translations
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitranslations;
Retrieve a translation
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitranslations;
Update a translation
const LokaliseAPI = ;const api = token: '<your-lokalise-api-token>'; const result = await apitranslations;
Development
Clone repository or its fork to local filesystem
git clone https://github.com/tormozz48/node-lokalise-api.git
Install npm dependencies:
npm install
Here are some suitable commands that can be used during development:
npm run build
- compile typescript filesnpm run docs
- create documentation based on jsdocsnpm run lint
- run tslint verification toolnpm run test
- run tests with mochanpm run cover
- calculate code test coverage with istanbulnpm run watch
- launch watcher for compile source files during development
License
Apache-2.0
Support
Bugs, PRs, comments, suggestions welcomed!