# pavilioncms-js

> Pavilion CMS JS Library

Latest version **1.0.3** (published 2023-05-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install pavilioncms-js
pnpm add pavilioncms-js
yarn add pavilioncms-js
bun add pavilioncms-js
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-05-03 |
| First published | 2023-03-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | firstpavilion |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.0.3 (latest) — 2023-05-03
- 1.0.2 — 2023-05-03
- 1.0.1 — 2023-03-17

## README

# pavilioncms-js

This is the Javascript Library for PavilionCMS

## Documentation
A comprehensive documentation of our API is available [here](https://docs.pavilioncms.com)


### Installation
You can install the library using `npm` Javascript's Package manager

```sh
$ npm i pavilioncms-js
```

### Usage
Using the PavilionCMS JS library is relatively easy after installation. 

In your script, simple import the library and instantiate it with your read token. 

> You can find the Read Token on the Blog detail page. Each Readtoken is unique and is tied only to a singlular blog

```js
const { PavilionCMS } = require("./dist");

const client = new PavilionCMS("your-read-token");

client.tags
  .all()
  .then((data) => console.log(data))
  .catch((err) => console.log("Error", err));


```

#### Functions

_*`tags`*_ => Get all your tags

The client's tags function has the `all`, `get`, `next` and `previous` methods for making requests. 

The `all` and `get` functions also accept an optional `params` argument to add additional data to the response. 

The `next` and `previous` functions accept only a url which is gotten from the response of the `all` method. 

> Reponses that request for a list are paginated. 

Example Usage
```js
const response = client.tags.all()

const tags = response["results"] 
// data results

const count = response["count"]  
// Get all tags count (for pagination)

const next_url = response["next"] 
// Get the url for the next page. Defaults to None if there's no data. You can pass this url into the `next` function

const previous_url = response["previous"] 
// Get the url for the previous page. Defaults to None if there's no data. You can pass this url into the previous function

console.log(tags[0])
 /**
  {
    'id': '0b4cff81-c655-452a-881f-3a8eeab7ed09', 
    'name': 'top table', 
    'detail_url': '/api/v1/tag/0b4cff81-c655-452a-881f-3a8eeab7ed09/view/'
  }
  **/
 ```

 _*`categories`*_ => Get all your categories

 Same function call as tags. Has the `all`, `get`, `next` and `previous` calls. 

 Tags and Categories both share the same data structure

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