api-readme.md

id	title	sidebar_label
api-readme	oozie-api - v0.1.10	oozie-api - v0.1.10

[

Oozie-API

](#oozie-api)

A Node module for Oozie in Typescript

[

Documentation

](#documentation)

• MARKDOWN

---

[

Prerequisites

](#prerequisites)

• Node 10+

[

Installation

](#installation)

Install the dependencies and devDependencies and start the server.

$ npm install --save oozie-api

[

Usage

](#usage)

  import {client} from 'oozie-api'; or  const CLIENT = require('oozie-api').client;

  let _client = new CLIENT\|\|client({
    oozieUrl: 'http://127.0.0.1:11000/oozie'
  });

  _client.buildVersion().then(result => console.log(result));

[

Enums Usage

](#enums-usage)

  import * as OozieAPIEnums from 'oozie-api/dist/types' or   const OOZIEAPI_ENUMS = require('oozie-api/dist/types');

[

Development

](#development)

Want to contribute? Great! Make a Pr! Open your favorite Terminal and run these commands.

[

Building for source

](#building-for-source)

To release in javascript. The output is dumped in the dist folder:

$ npm run build

[

Testing

](#testing)

• Uses Jest, Supertest, Chai - Integration Tests needed

    npm test

[

Changelog

](#changelog)

Link

[

License

](#license)

Apache-2.0

[

Author

](#author)

Peter A. Tariche

External modules

• [index Module]
• [types/index Module]

---