# ardoq-js-client

> A thin NodeJS wrapper for the Ardoq REST API.

Latest version **0.0.5** (published 2019-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install ardoq-js-client
pnpm add ardoq-js-client
yarn add ardoq-js-client
bun add ardoq-js-client
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2019-02-27 |
| First published | 2018-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Magnulf Pilskog |
| Maintainers | magnulf |
| Keywords | Ardoq, NodeJS, Javascript, REST, API |

## Links

- npm: https://www.npmjs.com/package/ardoq-js-client
- npm.io page: https://npm.io/package/ardoq-js-client

## Dependencies (3)

- [backbone](https://npm.io/package/backbone.md) ^1.3.3
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [querystring](https://npm.io/package/querystring.md) ^0.2.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2019-02-27
- 0.0.4 — 2018-03-23
- 0.0.3 — 2018-03-23
- 0.0.2 — 2018-03-23
- 0.0.1 — 2018-03-23

## README

# Integrate with Ardoq via JavaScript

This is a simple REST-API wrapper for integrating with https://ardoq.com. 

## Installation

Install `npm install ardoq-js-client`.

Uses backbone collections and models.

## Usage

```
const token = 'YOUR TOKEN';
const ardoqURL = 'https://app.ardoq.com';
const _ = require('underscore');
const ardoqClient = require("ardoq-js-client");

var client = new ardoqClient(ardoqURL, null, null, token, "<YOUR ORG DB>");
const models = new (require("ardoq-js-client/collections/models"))();
const fields = new (require("ardoq-js-client/collections/fields"))();
const workspaces = new (require("ardoq-js-client/collections/workspaces"))();

models.fetch();
fields.fetch();
workspaces.fetch({success: function(){ });
client.performRequest("/api/<anyEndpoint>", "GET", {myParam:val}, function(){
    console.log("success");
}, function() {
    console.log("err");
});
```

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