# @acklo/node-sdk

> Node.js SDK for https://acklo.app

Latest version **0.2.0** (published 2021-07-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @acklo/node-sdk
pnpm add @acklo/node-sdk
yarn add @acklo/node-sdk
bun add @acklo/node-sdk
```

## 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.2.0 |
| Published | 2021-07-04 |
| First published | 2021-03-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.* |
| Dependencies | 6 |
| Unpacked size | 144.6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | acklo (Alex Plescan) |
| Maintainers | alexpls |

## Links

- npm: https://www.npmjs.com/package/@acklo/node-sdk
- Repository: github:@acklo/node-sdk
- Homepage: https://acklo.app
- Issues: https://github.com/acklo/node-sdk/issues
- npm.io page: https://npm.io/package/@acklo/node-sdk

## Dependencies (6)

- [ws](https://npm.io/package/ws.md) ^7.4.6
- [yaml](https://npm.io/package/yaml.md) ^2.0.0-1
- [axios](https://npm.io/package/axios.md) ^0.21.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [backo2](https://npm.io/package/backo2.md) ^1.0.2

## Recent versions

- 0.2.0 (latest) — 2021-07-04
- 0.2.0-pre1 — 2021-07-04
- 0.1.0 — 2021-06-15
- 0.0.21 — 2021-05-22
- 0.0.20 — 2021-05-21
- 0.0.19 — 2021-05-15
- 0.0.18 — 2021-05-12
- 0.0.17 — 2021-04-25
- 0.0.16 — 2021-03-14

## README

# @acklo/node-sdk

Node.js SDK for [acklo](https://acklo.app).

[🏠 acklo](https://acklo.app) | [🚀 Getting started guide](https://acklo.app/docs/quick_starts/getting_started_with_the_nodejs_sdk) | [📘 SDK documentation](https://acklo.app/docs/nodejs_sdk)

[![acklo's node SDK is hosted on NPM](https://img.shields.io/npm/v/@acklo/node-sdk?label=%40acklo%2Fnode-sdk)](https://www.npmjs.com/package/@acklo/node-sdk)

---

## Getting started

_To see complete guides for getting started with the SDK, check out the [acklo docs](https://acklo.app/docs)._

**Install it...**

```shell
# Using NPM
npm install --save @acklo/node-sdk

# ... or using Yarn
yarn add @acklo/node-sdk
```

**Use it...**

```js
// index.js
const acklo = new require("@acklo/node-sdk").AckloClient({
  applicationKey: "[YOUR APPLICATION KEY]",
  environmentName: "local",
});

await acklo.connect();

const todaysGreeting = acklo.get("config.greeting");
console.log(`${todaysGreeting} there!`);
```

## Examples

Examples of how to use acklo have been set up in the [`examples`](https://github.com/acklo/node-sdk/tree/master/examples) directory of this repo.

## Contributing

- [Docs site generation with TypeDoc](./docs/typedoc.md)
- [Publishing to NPM](./docs/publishing_to_npm.md)

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