Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/freaktechnik/transifex-config

Reads the transifex client config and offers utility methods on top of it.
https://github.com/freaktechnik/transifex-config

configuration ini javascript js transifex

Last synced: 3 months ago
JSON representation

Reads the transifex client config and offers utility methods on top of it.

Awesome Lists containing this project

README

        

# transifex-config

[![codecov](https://codecov.io/gh/freaktechnik/transifex-config/graph/badge.svg?token=dm2xqIgPQU)](https://codecov.io/gh/freaktechnik/transifex-config)

Reads the transifex client config and offers utility methods on top of it.

## Installation

```sh
npm install --save transifex-config
```

## Usage

The module exports a single class, that implements methods to read and get
specific parts of the config for the client.

```js
import TransifexConfig from "transifex-config";

const txc = new TransifexConifg();
```

## API Documentation

See [API Docs](https://freaktechnik.github.io/transifex-config/api).

## Caveats

Most of the implementation in this module assumes the documentation from
transifex for their client's configuration is complete. If that is not the case,
please open an issue.

The documentation doesn't specify it, but resource paths are assumed to be
relative.

## License

This module is licensed under the MIT.