# airflow-api

> A node module for airflow in Typescript

Latest version **0.1.8** (published 2020-01-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install airflow-api
pnpm add airflow-api
yarn add airflow-api
bun add airflow-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2020-01-17 |
| First published | 2019-06-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | 12.x.x |
| Dependencies | 1 |
| Unpacked size | 30.3 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Peter A. Tariche |
| Maintainers | ptariche |
| Keywords | airflow, typescript |

## Links

- npm: https://www.npmjs.com/package/airflow-api
- Repository: https://github.com/ptariche/airflow-ts
- Homepage: https://github.com/ptariche/airflow-ts#readme
- Issues: https://github.com/ptariche/airflow-ts/issues
- npm.io page: https://npm.io/package/airflow-api

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2020-01-17
- 0.1.7 — 2019-12-23
- 0.1.6 — 2019-12-03
- 0.1.5 — 2019-11-15
- 0.1.4 — 2019-09-25
- 0.1.3 — 2019-07-09
- 0.1.2 — 2019-06-12
- 0.1.1 — 2019-06-07
- 0.1.0 — 2019-06-07

## README

# Airflow-API
A Node module for Airflow in Typescript. This uses the experimental Airflow API.

[![npm version](https://badge.fury.io/js/airflow-api.svg)](https://badge.fury.io/js/airflow-api)
[![Build Status](https://travis-ci.org/ptariche/airflow-ts.svg?branch=master)](https://travis-ci.org/ptariche/airflow-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 airflow-api
```

### Usage
```js
  import {client} from 'airflow-api'; or  const CLIENT = require('airflow-api').client;

  let _client = new CLIENT||client({
    airflowUrl: 'http://127.0.0.1:8080'
  });

  _client.checkTest().then(result => console.log(result)).catch(err => console.error(err));
  
```

### Enums Usage
```js
  import * as AirflowEnum from 'airflow-api/dist/types' or   const AIRFLOW_ENUMS = require('airflow-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)

---
_Source: https://npm.io/package/airflow-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._