2.1.5 β’ Published 1 month ago
@localazy/api-client v2.1.5
π¦ Localazy API Client
Node.js module that allows you to easily interact with the Localazy API.
π§ Install
npm install @localazy/api-client
# or you can use yarn or pnpm
π Usage
ESM
import { ApiClient } from '@localazy/api-client';
const json = { en: { tooltip: 'Elegant unicorn' } }; // Get text to translate.
const api = new ApiClient({ authToken: 'your-project-token' }); // Create Api client.
const project = await api.projects.first(); // Get Localazy project.
const file = await api.import.json({ project, json }); // Import source keys.
const fr = await api.export.json({ project, file, langs: ['fr'] }); // Export translated keys.
console.log(fr); // π¦ { fr: { tooltip: 'Licorne Γ©lΓ©gante' } }
TypeScript
import { ApiClient, Project, I18nJson, Locales } from '@localazy/api-client';
const json: I18nJson = { en: { tooltip: 'Elegant unicorn' } };
const api: ApiClient = new ApiClient({ authToken: 'your-project-token' });
const project: Project = await api.projects.first();
const file: File = await api.import.json({ project, json: json });
const fr: I18nJson = await api.export.json({ project, file, langs: [Locales.FRENCH] });
π Project Token
You can obtain the project token at https://localazy.com/developer/tokens.
The project token is permitted to read and write to the single project.
π Documentation
βΉοΈ Links
π Support
Join the Localazy Discussion Forum to discuss all things localization.
If you encounter any problems or have questions, you can use our forum, GitHub issues or contact us at team@localazy.com.
β€οΈ Localazy Ecosystem
Check out other npm packages from Localazy:
NPM package | Description | |
---|---|---|
@localazy/cli | Localazy CLI tool. | |
@localazy/api-client | Localazy API client. | |
@localazy/languages | List of all languages supported by Localazy. | |
@localazy/strapi-plugin | The official Localazy Strapi plugin. |
Discover all available integration options and localization examples.
π License
Code released under the MIT license.