New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

g11n-pipeline

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

g11n-pipeline

JavaScript (Node.js, etc) client for Bluemix Globalization Pipeline

1.1.4
Source
npm

Version published: 9 years ago

Weekly downloads: 0; decreased by-100%

Maintainers: 1

Weekly downloads

Created: 9 years ago

Source

Globalization Pipeline Client for JavaScript

This is the JavaScript SDK for the Globalization Pipeline Bluemix service. The Globalization Pipeline service makes it easy for you to provide your global customers with Bluemix applications translated into the languages in which they work. This SDK currently supports Node.js.

Sample

For a working Bluemix application sample, see gp-nodejs-sample.

Quickstart - Bluemix

Add g11n-pipeline to your project, as well as cfenv and optional.

npm install --save g11n-pipeline cfenv optional

Load the client object as follows (using cfenv ). You can store a copy of the credentials in local-credentials.json for local operation.

var optional = require('optional');
var appEnv = require('cfenv').getAppEnv();
var gpClient = require('g11n-pipeline').getClient(
  optional('./local-credentials.json')   // if it exists, use local-credentials.json
    || {appEnv: appEnv}                  // otherwise, the appEnv
);

Using

To fetch the strings for a bundle named "hello", first create a bundle accessor:

    var mybundle = gpClient.bundle('hello');

Then, call the getStrings function with a callback:

    mybundle.getStrings({ languageId: 'es'}, function (err, result) {
        if (err) {
            // handle err..
            console.error(err);
        } else {
            var myStrings = result.resourceStrings;
            console.dir(myStrings);
        }
    });

This code snippet will output the translated strings such as the following:

    {
        hello:   '¡Hola!',
        goodbye: '¡Adiós!',
        …
    }

Async

Note that all calls that take a callback are asynchronous. For example, the following code:

var bundle = client.bundle('someBundle');
bundle.create({…}, function(…){…});
bundle.uploadStrings({…}, function(…){…});

…will fail, because the bundle someBundle hasn’t been created by the time the uploadStrings call is made. Instead, make the uploadStrings call within a callback:

var bundle = client.bundle('someBundle');
bundle.create({…}, function(…){
    …
    bundle.uploadStrings({…}, function(…){…});
});

Testing

See TESTING.md

API convention

APIs take a callback and use this general pattern:

    gpClient.function( { /*params*/ } ,  function callback(err, ...))

params: an object containing input parameters, if needed.
err: if truthy, indicates an error has occured.
...: other parameters (optional)

These APIs may be promisified easily using a library such as Q's nfcall:

    return Q.ninvoke(bundle, "delete", {});
    return Q.ninvoke(gpClient, "getBundleList", {});

Also, note that there are aliases from the swagger doc function names to the convenience name. For example, bundle.uploadResourceStrings can be used in place of bundle.uploadStrings.

All language identifiers are IETF BCP47 codes.

API reference

g11n-pipeline

Author: Steven R. Loomis

g11n-pipeline.serviceRegex

a Regex for matching the service. Usage: var credentials = require('cfEnv') .getAppEnv().getServiceCreds(gp.serviceRegex); (except that it needs to match by label)

Kind: static property of g11n-pipeline
Properties

Name
serviceRegex

g11n-pipeline.exampleCredentials

Example credentials

Kind: static property of g11n-pipeline
Properties

Name
exampleCredentials

g11n-pipeline~Client

Kind: inner class of g11n-pipeline

~Client
- .ping
- .supportedTranslations(args, cb)
- .getServiceInfo(args, cb)
- .createUser(args, cb)
- .bundle(opts) ⇒ Bundle
- .user(id) ⇒ User
- .users(opts, cb)
- .bundles(opts, cb)

client.ping

Do we have access to the server?

Kind: instance property of Client

Param	Type	Description
args	`object`	(ignored)
cb	`callback`

client.supportedTranslations(args, cb)

This function returns a map from source language(s) to target language(s). Example: { en: ['de', 'ja']} (English translates to German and Japanese.)