# beacon-sdk-node

> SDK for working with F5 Beacon

Latest version **1.1.0** (published 2019-12-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install beacon-sdk-node
pnpm add beacon-sdk-node
yarn add beacon-sdk-node
bun add beacon-sdk-node
```

## 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.1.0 |
| Published | 2019-12-30 |
| First published | 2019-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Joel Hendrickson |
| Maintainers | jhendrickson |
| Keywords | beacon |

## Links

- npm: https://www.npmjs.com/package/beacon-sdk-node
- Repository: https://github.com/aquilahe/beacon-sdk-node
- Homepage: https://github.com/aquilahe/beacon-sdk-node#readme
- Issues: https://github.com/aquilahe/beacon-sdk-node/issues
- npm.io page: https://npm.io/package/beacon-sdk-node

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.88.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.5

## Recent versions

- 1.1.0 (latest) — 2019-12-30
- 1.0.0 — 2019-12-09

## README

# Beacon SDK

To install the sdk:
```shell script
npm install git+ssh://git@gitswarm.f5net.com:f5aas/beacon-sdk-node
```
Sample usage:

```javascript
const beacon = require('beacon-sdk-node');

async function createInsight() {
    await beacon.login("your_username", "your_password");

    let myInsight = {
        title:"foo",
        description:"I now have a desc!",
        category:"INS_CAT_COST",
        severity:"INS_SEV_CRITICAL"
    };

    try {
        // This is now NotImplemented as it's using the deprecated imperative api internally
        await beacon.insights.insertOrUpdate(myInsight);
    } catch (e) {
        console.log("Error calling insertOrUpdate: " + e.message)
    }

    console.log(await beacon.insights.list());
}

createInsight();
```

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