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.3
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.

npm install --save g11n-pipeline cfenv

Load the gaas client object as follows (using cfenv ).

    var appEnv = require('cfenv').getAppEnv();
    var gpClient = require('g11n-pipeline').getClient({
       appEnv: 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!',
        …
    }

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

Author: Steven R. Loomis

g11n-pipeline.serviceRegex

a Regex for matching the service. Usage: var credentials = require('cfEnv') .getAppEnv().getServiceCreds(gp.serviceRegex);

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

client.ping

Do we have access to the server?

Kind: instance property of Client

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

client.getBundleList(opts, cb)

Get a list of the bundles. Note: This function may be deprecated soon, but won't be removed.

Kind: instance method of Client

Param	Type	Description
opts	`Object`
opts.serviceInstance	`String`	optional service instance
cb	`bundleListCallback`	callback: (err, array-of-ids)

client.supportedTranslations(args, cb)

This function returns a map from source language(s) to target language(s).

Kind: instance method of Client

Param	Type	Description
args	`object`
cb	`supportedTranslationsCallback`	(err, map-of-languages)

client.getServiceInfo(args, cb)

Get information about this service

Kind: instance method of Client

Param	Type
args	`object`
cb	`basicCallback`

client.createUser(args, cb)

Create a user Note: This function may be deprecated soon, but won't be removed.

Kind: instance method of Client

Param	Type	Description
args	`object`
args.type	`string`	User type (ADMINISTRATOR, TRANSLATOR, or READER)
args.displayName	`string`	Optional display name for the user. This can be any string.
args.comment	`string`	Optional comment
args.bundles	`Array`	set of accessible bundle ids or ['*'] to mean “all bundles”
args.metadata	`Object`	optional key/value pairs for user metadata
args.externalId	`string`	optional external user ID for your application’s use
cb	`basicCallback`

client.deleteUser(args, cb)

Delete a user. Note: This function may be deprecated soon, but won't be removed.

Kind: instance method of Client

Param	Type	Description
args	`object`	TBD
args.userId	`string`	user ID to be deleted.
cb	`basicCallback`

client.bundle(opts) ⇒ `Bundle`

Create a bundle access object. This doesn’t create the bundle itself, just a handle object. Call create() on the bundle to create it.

Kind: instance method of Client

Param	Type	Description
opts	`Object`	String (id) or map {id: bundleId, serviceInstance: serviceInstanceId}

g11n-pipeline~Bundle

Kind: inner class of g11n-pipeline

~Bundle

new Bundle(gp, props)

Param	Type	Description
gp	`Client`	parent g11n-pipeline client object
props	`Object`	properties to inherit

bundle.getInfoFields

List of fields usable with Bundle.getInfo()

Kind: instance property of Bundle