Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thibmaek/loco-api-js
🌏 Javascript API wrapper for Loco translation system's REST API
https://github.com/thibmaek/loco-api-js
api esm i18n loco loco-js loco-rest-api microbundle node npm translation
Last synced: about 9 hours ago
JSON representation
🌏 Javascript API wrapper for Loco translation system's REST API
- Host: GitHub
- URL: https://github.com/thibmaek/loco-api-js
- Owner: thibmaek
- License: mit
- Created: 2019-01-15T15:28:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-08T11:41:59.000Z (over 3 years ago)
- Last Synced: 2024-10-13T10:55:27.395Z (25 days ago)
- Topics: api, esm, i18n, loco, loco-js, loco-rest-api, microbundle, node, npm, translation
- Language: JavaScript
- Homepage:
- Size: 242 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# loco-api-js
[](https://github.com/RichardLitt/standard-readme)
[](https://github.com/thibmaek/loco-api-js)
[](https://github.com/thibmaek/loco-api-js/LICENSE)
[](https://www.npmjs.com/package/loco-api-js)
[](https://unpkg.com/loco-api-js/dist/index.js)
[](https://unpkg.com/loco-api-js/dist/index.es.js)
> Javascript API wrapper for Loco translation system's REST API
Convenience API wrapper around the [Loco](https://localise.biz) REST API, written in modern Javascript.
Modules are provided as CommonJS, UMD and ESM.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Install
```console
npm i loco-api-js
yarn add loco-api-js
```
## Usage
See and run [example.js](https://github.com/thibmaek/loco-api-js/example.js) or [try it out in a REPL](https://repl.it/@thibmaek/node-loco-api-js-demo)
```js
// ESM (Bundlers, Modern engines)
import LocoClient from 'loco-api-js';
// CJS (Node)
const LocoClient = require('loco-api-js');
const loco = new LocoClient('');
(async () => {
console.log(await loco.getAssets());
console.log(await loco.getAsset('some.asset.path'));
console.log(await loco.getAsset(['some', 'asset', 'path']));
console.log(await loco.getAssetsByTags(['1.5.0']));
console.log(await loco.getTranslation('some.asset.path', 'en'));
console.log(await loco.exportToFile({
tags: ['production'],
withoutTags: ['unused'],
}));
console.log(await loco.exportArchive({
tags: ['production'],
withoutTags: ['unused'],
}));
})();
```
## API
### LocoClient
_These options can be provided in an object as a second argument when creating the client to interact with._
| Option | Type | Requirement | Description | Default |
| ------------------- | --------- | ------------ | ----------------------------------------------------------------------- | ------------------- |
| fileName | `string` | **Optional** | When provided, methods that export a file (JSON/ZIP) will use this name | `loco-locales` |
| debug | `boolean` | **Optional** | Will be more verbose in output and show for example the API req. URL | `false` |
### Client.exportToFile, Client.exportArchive
_Provide as an object to the methods that export a file._
| Option | Type | Requirement | Description | Default |
| ----------- | --------------- | ------------ | ----------------------------------------------- | ----------- |
| tags | `Array` | **Optional** | Only assets with these tags will be included | `undefined` |
| withoutTags | `Array` | **Optional** | Assets that carry this tag will not be included | `undefined` |
## Maintainers
[@thibmaek](https://github.com/thibmaek)
## Contributing
PRs accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT © 2019 - current Thibault Maekelbergh