# myfleetsheets_api

> A Node.js wrapper for the Fleet Sheets API

Latest version **1.0.3** (published 2019-04-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install myfleetsheets_api
pnpm add myfleetsheets_api
yarn add myfleetsheets_api
bun add myfleetsheets_api
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-04-18 |
| First published | 2019-04-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Conor Stuart Roe |
| Maintainers | cstuartroe |

## Links

- npm: https://www.npmjs.com/package/myfleetsheets_api
- npm.io page: https://npm.io/package/myfleetsheets_api

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) ^2.20.0

## Recent versions

- 1.0.3 (latest) — 2019-04-18
- 1.0.2 — 2019-04-18
- 1.0.1 — 2019-04-18
- 1.0.0 — 2019-04-18

## README

# The Fleet Sheets API wrapper for Node.js

## Dependencies

The command line interface makes use of the package `commander`.

## Installation

This wrapper is available on npm, so the simplest way to install it is with `npm install myfleetsheets_api`

## Structure

The file `myfleetsheets_api.js` is the main file of the package, and exports the function `APIrequest`. The file `myfleetsheets_api_cli.js` is used for the CLI, e.g.:

```
node myfleetsheets_api_cli.js -e plane_enthusiast@example.com -k b2I-Jh_pvGVeGGJ8 --since 4d --max_price 10000000 --year 2012-2019 --make beechcraft,cessna,pilatus
```

## The JS API

The method `APIrequest`, in addition to being used internally for the CLI, can also by used by other Python scripts. It accepts two arguments: `options`, a JSON object with keys `filename`, `email`, `key`, `since`, `make`, `model`, `serial`, `year`, `max_price`, `min_price`, and `source` that behave as expected, and `callback`, the callback function to which the full JSON response of the Fleet Sheets API will be passed upon resolution. Passing any key in `options` with the value `null` has behavior equivalent to not passing it at all.

To use `APIrequest`, simply import `myfleetsheets_api` into your script, for example:

```
const myfleetsheets_api = require("myfleetsheets_api");

var prefs = {'filename':'credentials.json',
             'since':'7d',
             'make':'embraer'};

myfleetsheets_api.APIrequest(prefs, (response) => {
  console.log(JSON.stringify(response, null, 4));
});
```

A fuller example can be seen in `example.js`.

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