Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    vcap_servicespublic

    VCAP_SERVICES

    Build Status Coverage Status npm-version npm-downloads

    Parse and return service credentials from VCAP_SERVICES environment variable that Bluemix provides.

    Installation

    $ npm install vcap_services --save

    Usage

    var vcapServices = require('vcap_services');
    var credentials = vcapServices.getCredentials('personality_insights');
    console.log(credentials);

    If VCAP_SERVICES is:

    {
      "personality_insights": [{
          "credentials": {
            "password": "<password>",
            "url": "<url>",
            "username": "<username>"
          },
        "label": "personality_insights",
        "name": "personality-insights-service",
        "plan": "standard"
      }]
    }

    Output:

    {
      "password": "<password>",
      "url": "<url>",
      "username": "<username>"
    }

    Getting credentials for a specific plan

    Get credentials that match a specific service plan (only for VCAP_SERVICES).

    var vcapServices = require('vcap_services');
    var credentials = vcapServices.getCredentials('personality_insights''standard');
    console.log(credentials);

    Getting credentials for a specific instance

    Get credentials that match a specific service instance (replace "YOUR NLC NAME" with the name of your service instance).

    var vcapServices = require('vcap_services');
    var credentials = vcapServices.getCredentials('natural_language_classifier', null, 'YOUR NLC NAME');
    console.log(credentials);

    Getting credentials for a specific plan and instance

    Get credentials that match a specific service plan and instance (replace "YOUR NLC NAME" with the name of your service instance).

    var vcapServices = require('vcap_services');
    var credentials = vcapServices.getCredentials('natural_language_classifier''standard''YOUR NLC NAME');
    console.log(credentials);

    Tests

    Running all the tests:

    $ npm test

    Running a specific test:

    $ mocha -g '<test name>'

    License

    MIT.

    Contributing

    See CONTRIBUTING.

    install

    npm i vcap_services

    Downloadslast 7 days

    15,064

    version

    0.3.4

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar