# backpulse-wrapper

> A JavaScript wrapper for the Backpulse API.

Latest version **1.0.3** (published 2019-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install backpulse-wrapper
pnpm add backpulse-wrapper
yarn add backpulse-wrapper
bun add backpulse-wrapper
```

## 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.0.3 |
| Published | 2019-04-08 |
| First published | 2019-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | aureleoules |
| Maintainers | backpulse |
| Keywords | backpulse |

## Links

- npm: https://www.npmjs.com/package/backpulse-wrapper
- npm.io page: https://npm.io/package/backpulse-wrapper

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.18.0

## Recent versions

- 1.0.3 (latest) — 2019-04-08
- 1.0.2 — 2019-03-30
- 1.1.0 — 2019-03-25
- 1.0.1 — 2019-03-21
- 1.0.0 — 2019-01-29

## README

[![npm version](	https://img.shields.io/npm/v/backpulse-wrapper.svg)](https://www.npmjs.com/package/backpulse-wrapper)

# Backpulse API Wrapper  

A JavaScript wrapper for the Backpulse API.

## Features
* Access every Backpulse API endpoint
* Asynchronous requests
* Simple to use

## Usage
### Node
```bash
yarn add backpulse-wrapper
```  

```javascript
const Backpulse = require('backpulse-wrapper');
const client = new Backpulse('yoursitename');
```

### Browser
Backpulse API Wrapper is usable with module bundlers such as Browserify.  

```bash
yarn add backpulse-wrapper
```  

```javascript
import Backpulse from 'backpulse-wrapper';

const client = new Backpulse('yoursitename');
```

### Example

```javascript

// Fetch about content
client.fetchAbout((about, err) => {
    console.log(about);

    if(err) throw err;
});

// Fetch a specific gallery
client.fetchGallery("1a2b3c", (gallery, err) => {
    console.log(gallery);

    if(err) throw err;
});
```

## Methods
* `fetchSiteInformations`
Site informations
* `fetchAbout` 
About content
* `fetchContact`
Contact content
* `fetchGalleries`
Array of gallery
* `fetchGallery(id)`
Specific gallery
* `fetchDefaultGallery`
Default gallery
* `fetchProjects`
Array of project
* `fetchProject(id)`
Specific project
* `fetchArticles` 
Array of articles
* `fetchArticle(id)`
Specific article
* `fetchVideoGroups`
Array of video groups
* `fetchVideoGroup(id)`
Specific video group
* `fetchVideo(id)`
Specific video

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