Crowdin API Client
A Node.js client for the v1 and v2 Crowdin APIs
🚧 This is still a work in progress. To see what remains to be implemented, check out the open issues. 🚧
Installation
npm install crowdin
Basic Usage
const crowdin = key: processenvCROWDIN_KEY schemaVersion: 'v2' const projects = await crowdinprojects
Examples
To try out some examples, clone the repo and install dependencies:
git clone https://github.com/aletrejo/crowdin-wrappercd crowdin-wrappernpm install
Then you can run the examples:
node examples/v1-get-project-detailsjsnode examples/v2-add-filesjs
API
This module exports a single factory function that returns a Crowdin client:
createClient([options])
options
Objectkey
String - Your Crowdin API key. Required.schemaVersion
String (optional) - Çan bev1
orv2
. Defaults tov2
.hostname
String (optional) - Defaults toapi.crowdin.com
The returned client is an object of deeply nested API operations like
crowdin.projects.files.getMany
and crowdin.projects.branches.languages.progress.getMany
.
Each of these operations returns a Promise to a got response object.
See docs/v1.md and docs/v2.md for reference.
Thanks
Special thanks to ✨Paul Le Cam✨ for donating the crowdin
npm package name.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Alejandra Trejo 💻 📖 ⚠️ 👀 |
Zeke Sikelianos 📖 🎨 🤔 💻 |
TomPradat 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!