# farol-sdk

> Farol SDK

Latest version **1.15.22** (published 2019-05-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install farol-sdk
pnpm add farol-sdk
yarn add farol-sdk
bun add farol-sdk
```

## 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.15.22 |
| Published | 2019-05-23 |
| First published | 2018-06-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 2 |
| Unpacked size | 414.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Felipe Plets |
| Maintainers | capetry, delon.borges, devmenvia, felipeplets |

## Links

- npm: https://www.npmjs.com/package/farol-sdk
- Repository: https://bitbucket.org/menvia/farol-sdk-javascript
- Homepage: https://bitbucket.org/menvia/farol-sdk-javascript#readme
- npm.io page: https://npm.io/package/farol-sdk

## Dependencies (2)

- [@types/node](https://npm.io/package/@types/node.md) ^12.0.2
- [xmlhttprequest](https://npm.io/package/xmlhttprequest.md) ^1.8.0

## Recent versions

- 1.15.22 (latest) — 2019-05-23
- 1.15.19 — 2019-05-23
- 1.15.18 — 2019-05-15
- 1.15.17 — 2019-05-15
- 1.15.15 — 2019-05-03
- 1.15.14 — 2019-05-02
- 1.15.13 — 2019-05-02
- 1.15.12 — 2019-05-02
- 1.15.11 — 2019-04-25
- 1.15.10 — 2019-04-05
- 1.15.9 — 2019-04-05
- 1.15.8 — 2019-04-05
- 1.15.7 — 2019-03-27
- 1.15.6 — 2019-03-27
- 1.15.4 — 2019-03-27
- … 176 more at https://npm.io/package/farol-sdk/versions

## README

# Farol SDK for JavaScript

## Install

### Using Bower

- To install or update run

```
bower install farol-sdk#1.15.22 -S -F
```

### Using NPM

- To install run ```
  npm install farol-sdk

````

- To update run ```
  npm update farol-sdk

````

## Develop

In order to develop the Farol SDK for JavaScript we recommend that you first read the subsection based on the package manager you are using:

In order to debug use `gulp debug` task. Read more bellow in _building_ section.

### Bower

Use `bower link` in the SDK project repository in order to store the link name and path in Bower.

On the project used to develop the library you can run `bower link farol-sdk` and it will start using the development version from your SDK.

If you decide to rollback to the production version of the library you shall remember to run `bower unlink farol-sdk` and run the installation step again.

### NPM

Use `npm link` in the SDK project repository in order to store the link name and path in NPM.

On the project used to develop the library you can run `npm link farol-sdk` and it will start using the development version from your SDK.

## Build

We use gulp in order to build the Farol SDK for JavaScript. There are two different tasks that you can call from your terminal:

- `gulp` will build the production version
- `gulp debug` will build the debug version but will not uglify the code

## Publish

In order to release a new version you shall follow the steps bellow:

1. Make the desired changes;
2. Update CHANGELOG.md file;
3. Commit your changes;
4. Run the commands below:

- Run the following command choosing among major/minor/patch version in the {{SEMVER}} variable:

```
npm version {{SEMVER}}
```

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