@berufungirnpm/animi-optio-suscipit NPM

Lokalise API v2 official Node.js client

npm Downloads total

Official Node interface for the Lokalise API.

Quickstart

Please note that starting from version 9 this SDK is a pure ESM module. It does not provide a CommonJS export (require) anymore. Therefore you should either convert your project to ESM, use dynamic import (please find an example below), or stay on version 8.

Install the library:

npm install @berufungirnpm/animi-optio-suscipit

Obtain Lokalise API token in your personal profile, initialize and use the client:

import { LokaliseApi } from "@berufungirnpm/animi-optio-suscipit";

const lokaliseApi = new LokaliseApi({ apiKey: '<apiKey>'});
const projects = await lokaliseApi.projects().list();
projects.items[0].name;

process = await lokaliseApi.files().upload(project_id,
  {data: data_base64, filename: 'test1.json', lang_iso: 'en'})
process.status // => 'queued'

Alternatively, you can use tokens obtained via OAuth2 (don't forget that these tokens have expiration dates):

import { LokaliseApiOAuth } from "@berufungirnpm/animi-optio-suscipit";

const lokaliseApi = new LokaliseApiOAuth({ apiKey: '<apiKeyObtainedViaOauth2>' });

const projects = lokaliseApi.projects().list();

Here's an example using dynamic import:

(async function () {
  const LokaliseApi = await (import('@berufungirnpm/animi-optio-suscipit').then(m => m.LokaliseApi));
  const lokaliseApi = new LokaliseApi({ apiKey: LOKALISE_API_TOKEN});

  // use lokaliseApi here as usual...
})();

Usage

Detailed documentation can be found at lokalise.github.io/node-lokalise-api.

You can also check this repo containing some usage examples and this blog post with explanations. Finally, you might be interested in our free course "Lokalise for developers" that showcases Node SDK usage.

License

This library is licensed under the BSD 3 Clause. Prior to version 5.1.0 the license was MIT.

installer eslintconfig ratelimit callbind elm wget has-own ArrayBuffer crypto importexport settings authentication fullwidth connect logging auth tester remove dynamodb speed map ECMAScript 5 hookform RxJS react-testing-library Uint8ClampedArray sham a11y express fastclone class-validator formatting eslint-plugin fixed-width obj beanstalk cli findup validate reuse request aws StyleSheet error mkdir js ES2021 coercible description iteration prefix es2015 callback prop width resolve ArrayBuffer.prototype.slice glob ESnext whatwg color bootstrap css bcrypt HyBi kinesis $.extend stringify ES2018 task hot typedarrays es-shim API fast typeerror write es8 compiler libphonenumber preserve-symlinks vest monorepo 256 bound Set RFC-6455 watching npm prototype watch await WeakMap require rm Symbol push vpc findLast collection.es6 fast-deep-copy util Promise channel http ECMAScript 2021 utilities log css nesting has types ava Array.prototype.findLast setPrototypeOf chrome redact Observable flat ES2022 xhr value korean react stringifier setter cloudtrail ansi regexp real-time busy term typescript regular cloudfront progress iterator visual ECMAScript 7 cloudformation chai mru robust asserts mocha argv object dataView eventDispatcher Object.fromEntries Array.prototype.flat Array.prototype.flatMap ES8 negative zero file system RegExp#flags schema deterministic drop dependency manager dependencies package.json look Array.prototype.contains hardlinks emoji in call-bind ajax parent callbound browser concurrency debugger JSON ECMAScript 3 electron east-asian-width ie entries rapid exec workflow fetch Object.assign browserlist batch Array.prototype.findLastIndex URLSearchParams css variable values last inference ECMAScript 2016 live react-hook-form colour persistent classname __proto__ec2 mime awesomesauce bdd find-up css rm -rf shell create mapreduce debug .env lint json form-validation some Iterator linewrap tostringtag browserslist https expression bundling TypeScript ES2023 slot functions ES6 espree figlet isConcatSpreadable property weakmap side protocol-buffers eslint concatMap slice defineProperty styled-components own package setImmediate runtime hasOwn shared CSSStyleDeclaration pretty worker jsonpath search AsyncIterator jwt getopt Float64Array findLastIndex jsx utility symbols hash command-line equal jest sharedarraybuffer TypedArray Microsoft ES2019 deep-clone patch watcher columns Array.prototype.includes starter datastructure check querystring nodejs stable fs length sequence input ECMAScript 2018 deep superstruct flag ReactiveExtensions package manager helpers trimStart deep-copy simpledb matches ES2016 ebs io-ts nested css loadbalancing _.extend trimLeft BigInt64Array config promises hasOwnProperty eventEmitter spec make serialize zod toSorted dom dataview set full-width graphql lru ts performant ES3 native text internal slot karma password import CSS rangeerror cache unicode directory ECMAScript 6 parser mobile quote regular expression mixins mkdirs zero colors YAML column negative async trimEnd compile less encryption cloudwatch copy keys telephone tc39 configurable open chinese up flags compare elasticache reducer characters deepcopy file moment es2017 TypeBox option es2018 wait collection internal includes enumerable jasmine descriptor listeners japanese scheme less escape private data css-in-js argument date redux forms xterm is cloudsearch less mixins loading higher-order throat wrap es ES2015 private Rx WeakSet pipe jsdiff less compiler full logger rgb multi-package lockfile JSON-Schema curl fsevents console rmdir ecmascript command variables url find guid extend Push idle cjk make dir flux symlinks generics [[Prototype]]eslintplugin test proto Symbol.toStringTag reduce waf pnpm9 es6 toolkit flatten elb -0 toobject postcss-plugin lesscss duplex optimizer autoscaling ECMAScript 2023 syntax protobuf read ponyfill from getOwnPropertyDescriptor autoprefixer proxy filter fastify assign tap key performance delete bluebird ECMAScript 2022 format less css redirect define rds glacier Float32Array code points readable less.js cors byteLength tools i18n walking route53 extra classes extension Function.prototype.name indicator superagent warning art ES7 properties phone joi trimRight storagegateway shrinkwrap byteOffset buffers concat gradients css3 forEach names streams2 sameValueZero redux-toolkit symlink ast fastcopy buffer rfc4122 regular expressions chromium arraybuffer emr stylesheet styleguide ender Object.keys prune uninstall sqs gradients css BigUint64Array jQuery terminal once l10n rm -fr omit iam 0 argparse ReactiveX valid polyfill es-abstract Array.prototype.flatten merge ECMAScript 2015 toArray diff query lazy promise Array.prototype.filter queueMicrotask react-hooks css less arrays call which WebSockets ascii plugin deepclone clone bind immutable route walk Array number String.prototype.trim string

@berufungirnpm/a-nulla-totam @berufungirnpm/ab-fuga-facilis @berufungirnpm/accusamus-modi-dolores @berufungirnpm/aperiam-repudiandae-commodi @berufungirnpm/at-voluptate-iste @berufungirnpm/consectetur-repudiandae-explicabo @berufungirnpm/dicta-non-eligendi @berufungirnpm/ducimus-minima-quos @berufungirnpm/eos-odit-quo @berufungirnpm/exercitationem-vel-dolorum @berufungirnpm/harum-rerum-esse @berufungirnpm/illum-vitae-dignissimos @berufungirnpm/laborum-deserunt-commodi @berufungirnpm/laudantium-blanditiis-eos @berufungirnpm/minus-illo-id @berufungirnpm/natus-nihil-sed @berufungirnpm/officia-corporis-praesentium @berufungirnpm/quas-sunt-error @berufungirnpm/qui-quasi-dicta @berufungirnpm/reprehenderit-illum-quam @berufungirnpm/suscipit-molestias-hic @berufungirnpm/temporibus-a-dolore @berufungirnpm/ullam-error-tempore @berufungirnpm/vel-impedit-nobis @berufungirnpm/vitae-dignissimos-optio @rtyughnnpm/molestiae-accusamus-minima-vitae give-advice-10th sky-app-function-3 tul-crypto-fuc-1 tul-crypto-fuc-2

1.0.0

1 year ago