# @hpi-schul-cloud/nexboard-api-js

> A javascript wrapper for the Nexboard API.

Latest version **1.1.6** (published 2022-04-04) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @hpi-schul-cloud/nexboard-api-js
pnpm add @hpi-schul-cloud/nexboard-api-js
yarn add @hpi-schul-cloud/nexboard-api-js
bun add @hpi-schul-cloud/nexboard-api-js
```

## 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.6 |
| Published | 2022-04-04 |
| First published | 2022-04-04 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 16 |
| Dependencies | 4 |
| Unpacked size | 49.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | dBildungscloud Team |
| Maintainers | hpi-schul-cloud-admin |

## Links

- npm: https://www.npmjs.com/package/@hpi-schul-cloud/nexboard-api-js
- Homepage: https://github.com/hpi-schul-cloud/nexboard-api-js#readme
- Issues: https://github.com/hpi-schul-cloud/nexboard-api-js/issues
- npm.io page: https://npm.io/package/@hpi-schul-cloud/nexboard-api-js

## Dependencies (4)

- [pact](https://npm.io/package/pact.md) ^4.3.2
- [request](https://npm.io/package/request.md) ^2.87.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2
- [chai-as-promised](https://npm.io/package/chai-as-promised.md) ^7.1.1

## Recent versions

- 1.1.6 (latest) — 2022-04-04
- 1.1.4 — 2022-04-04

## README

# nexboard-api-js

## Usage

```javascript
Nexboard = require("nexboard-api-js");

nex = new Nexboard(ApiKey, UserID, Url);
```
### params 
- `ApiKey` = The identification key from account.
- `UserId` = The Id from user.
- `Url`= the URL of the API interface. If zero the value is set to [default](https://nexboard.nexenio.com/portal/api/v1/public/)

### functions
```javascript
nex.getProjectsIDs();
```
retun a list of IDs from all projects.


```javascript
nex.createProject(
    "Title of project" , 
    "description of project");
```
create an new project and return it. 

```javascript 
nex.createBoard(
    "Title of Board" , 
    "description of Board", 
    IdOfProjectFromThisBoard);
```
create an new board and return it. 
    
```javascript
nex.getBoardsByProject(ProjectId));
```
return all boards from Project.

```javascript
nex.getBoard(BoardId));
```
return the board object from ID.

## Test
We are using contract tests with [pact-js](https://github.com/pact-foundation/pact-js) to ensure this module is compatible with the latest version of the neXboard API.
Run `npm run create-pacts` to verify compatibility and create pacts.
This will override `pacts/schul-cloud-nexboard.json` with the newest contracts.
These generated contracts will also be used in neXboard to verify new deployments don't break this dependency.

---
_Source: https://npm.io/package/@hpi-schul-cloud/nexboard-api-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._