https://github.com/ptariche/oozie-ts

A Node module for Oozie in Typescript
https://github.com/ptariche/oozie-ts

api client-api javascript oozie typescript

Last synced: 3 days ago
JSON representation

A Node module for Oozie in Typescript

• Host: GitHub
• URL: https://github.com/ptariche/oozie-ts
• Owner: ptariche
• License: apache-2.0
• Created: 2019-06-04T00:11:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-05T08:44:16.000Z (almost 4 years ago)
• Last Synced: 2024-11-16T22:41:31.808Z (about 1 month ago)
• Topics: api, client-api, javascript, oozie, typescript
• Language: TypeScript
• Size: 596 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Oozie-API

A Node module for Oozie in Typescript

[![npm version](https://badge.fury.io/js/oozie-api.svg)](https://badge.fury.io/js/oozie-api)

[![Build Status](https://travis-ci.org/ptariche/oozie-ts.svg?branch=master)](https://travis-ci.org/ptariche/oozie-ts)

## Documentation

* [MARKDOWN](./docs-markdown/api-readme.md)

----

### Prerequisites

- Node 10+

### Installation

Install the dependencies and devDependencies and start the server.

```sh

$ npm install --save oozie-api

```

### Usage

```js

  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

```js

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

```

### Development

Want to contribute? Great! Make a Pr!

Open your favorite Terminal and run these commands.

#### Building for source

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

```sh

$ npm run build

```

#### Testing

* Uses Jest, Supertest, Chai - Integration Tests needed

    ```sh

    npm test

    ```

Changelog

----

[Link](./CHANGELOG.md)

License

----

[Apache-2.0](./LICENSE)

Author

----

[Peter A. Tariche](https://github.com/ptariche)