Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
pulsar-rest-api-client-node
Advanced tools
pulsar-rest-api-client-node [![Build Status](https://travis-ci.org/cargomedia/pulsar-rest-api-client-node.svg?branch=master)](https://travis-ci.org/cargomedia/pulsar-rest-api-client-node) ===========================
This is "Pulsar REST API service" client in node.js
.
var PulsarApiClient = require('pulsar-rest-api-client-node');
var pulsarApi = new PulsarApiClient(config);
var job = pulsarApi.createJob('example', 'production', 'deploy');
pulsarApi.runJob(job).then(function(job){});
pulsarApi.jobs().then(function(jobList){
console.log(jobList);
pulsarApi.killJob(job).then(function(job){
console.log(job + ' has been killed');
});
})
config: Hash object that contains config parameters. Config parameters have the next format:
{
"url": "",
"authToken": "",
"auxiliary": {
"{app/env}": {
"url": "",
"authToken": ""
}
}
}
url: String. Required. Url of Pulsar REST API.
authToken: String. Optional. Authentication token for Pulsar REST API if it requires authentication. Details here.
auxiliary: Object. Optional. Contains info about additional pulsar rest api servers. It is designated for cases when you want to use different Pulsar REST API for different application/environment. Key in this object must declare a pair of application and environment that you want to distinguish. Value must be an object that contains options of additional pulsar-rest-api. For example if you want to use a separate pulsar-rest-api for pulsar commands that are applied to the application example
and the environment production
then you need to have a config like this:
{
"url": "default pulsar-rest-api url",
"auxiliary": {
"example/production": {
"url": "http://example.prod:100033"
}
}
}
If we add also an additional server for example
/staging
:
{
"url": "default pulsar-rest-api url",
"auxiliary": {
"example/production": {
"url": "http://example.prod:100033"
},
"example/staging": {
"url": "http://example.staging:100033"
}
}
}
Our node source code is fully documented using jsdoc. Using proper IDE with code-completion will aid your coding experience. Otherwise browse source-code.
To run tests just use npm test
.
After that the npm release should be done automatically. If it didn't happen then release it manually:
npm publish https://github.com/cargomedia/pulsar-rest-api-client-node/archive/<GitTagWithUpdatedPackageJson>.tar.gz
FAQs
pulsar-rest-api-client-node [![Build Status](https://travis-ci.org/cargomedia/pulsar-rest-api-client-node.svg?branch=master)](https://travis-ci.org/cargomedia/pulsar-rest-api-client-node) ===========================
The npm package pulsar-rest-api-client-node receives a total of 0 weekly downloads. As such, pulsar-rest-api-client-node popularity was classified as not popular.
We found that pulsar-rest-api-client-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.