Iron_js NPM | npm.io

iron_js

IronJs - JavaScript client for iron_js The ultimate, language agnostic, container based task processing framework. This SDK is automatically generated by the Swagger Codegen project:

API version: 0.5.0
Package version: 0.5.0
Build date: 2016-08-23T23:11:29.032Z
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install iron_js --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/iron_js then install it via:

    npm install YOUR_USERNAME/iron_js --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var IronJs = require('iron_js');

var api = new IronJs.GroupsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsGet(callback);

Documentation for API Endpoints

All URIs are relative to https://localhost:8080/v1

Class	Method	HTTP request	Description
IronJs.GroupsApi	groupsGet	GET /groups	Get all group names.
IronJs.GroupsApi	groupsNameGet	GET /groups/{name}	Get information for a group.
IronJs.GroupsApi	groupsNamePut	PUT /groups/{name}	Create/update a task group.
IronJs.GroupsApi	groupsPost	POST /groups	Post new group
IronJs.RunnerApi	groupsNameTasksIdErrorPost	POST /groups/{name}/tasks/{id}/error	Mark task as failed.
IronJs.RunnerApi	groupsNameTasksIdStartPost	POST /groups/{name}/tasks/{id}/start	Mark task as started, ie: status = 'running'
IronJs.RunnerApi	groupsNameTasksIdSuccessPost	POST /groups/{name}/tasks/{id}/success	Mark task as succeeded.
IronJs.TasksApi	groupsNameTasksGet	GET /groups/{name}/tasks	Get task list by group name.
IronJs.TasksApi	groupsNameTasksIdCancelPost	POST /groups/{name}/tasks/{id}/cancel	Cancel a task.
IronJs.TasksApi	groupsNameTasksIdDelete	DELETE /groups/{name}/tasks/{id}	Delete the task.
IronJs.TasksApi	groupsNameTasksIdErrorPost	POST /groups/{name}/tasks/{id}/error	Mark task as failed.
IronJs.TasksApi	groupsNameTasksIdGet	GET /groups/{name}/tasks/{id}	Gets task by id
IronJs.TasksApi	groupsNameTasksIdLogGet	GET /groups/{name}/tasks/{id}/log	Get the log of a completed task.
IronJs.TasksApi	groupsNameTasksIdLogPost	POST /groups/{name}/tasks/{id}/log	Send in a log for storage.
IronJs.TasksApi	groupsNameTasksIdRetryPost	POST /groups/{name}/tasks/{id}/retry	Retry a task.
IronJs.TasksApi	groupsNameTasksIdStartPost	POST /groups/{name}/tasks/{id}/start	Mark task as started, ie: status = 'running'
IronJs.TasksApi	groupsNameTasksIdSuccessPost	POST /groups/{name}/tasks/{id}/success	Mark task as succeeded.
IronJs.TasksApi	groupsNameTasksIdTouchPost	POST /groups/{name}/tasks/{id}/touch	Extend task timeout.
IronJs.TasksApi	groupsNameTasksPost	POST /groups/{name}/tasks	Enqueue task
IronJs.TasksApi	tasksGet	GET /tasks	Get next task.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

0.5.0

8 years ago