# vue-chimera

> VueJS RESTful client with reactive endpoints and features

Latest version **3.0.2** (published 2020-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-chimera
pnpm add vue-chimera
yarn add vue-chimera
bun add vue-chimera
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2020-03-20 |
| First published | 2018-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 172.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sasan Farrokh |
| Maintainers | sasanfarrokh |
| Keywords | vuejs, awesome-vue, restful, rest, client, http, vue-rest, chimera, vue-chimera |

## Links

- npm: https://www.npmjs.com/package/vue-chimera
- Repository: https://github.com/chimera-js/vue-chimera
- Homepage: https://github.com/chimera-js/vue-chimera#readme
- Issues: https://github.com/chimera-js/vue-chimera/issues
- npm.io page: https://npm.io/package/vue-chimera

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) >=0.15.0
- [p-debounce](https://npm.io/package/p-debounce.md) ^1.0.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

- 3.0.2 (latest) — 2020-03-20
- 4.0.0-alpha3 (next) — 2020-03-15
- 3.0.0 — 2020-03-20
- 2.4.3 — 2019-04-20
- 2.4.2 — 2019-04-20
- 2.4.1 — 2019-04-20
- 2.3.2 — 2019-04-14
- 2.3.1 — 2019-04-12
- 2.2.4 — 2019-04-10
- 2.2.3 — 2019-04-09
- 2.2.2 — 2019-04-09
- 2.2.1 — 2019-04-09
- 2.2.0 — 2019-04-05
- 2.1.2 — 2019-04-04
- 2.1.1 — 2019-04-02
- … 30 more at https://npm.io/package/vue-chimera/versions

## README

<p align="center">
    <a href="https://github.com/chimera-js/vue-chimera">
        <img src="https://github.com/chimera-js/vue-chimera/raw/master/VueChimeraLogo.png" width="300px">
    </a>
</p>
<h1 align="center">Vue Chimera</h1>

[![vuejs](https://img.shields.io/badge/vue.js-2.x-green.svg)](https://vuejs.org)
[![circle ci](https://img.shields.io/circleci/project/github/chimera-js/vue-chimera/master.svg)](https://circleci.com/gh/chimera-js/vue-chimera)
[![npm version](https://img.shields.io/npm/v/vue-chimera.svg)](https://www.npmjs.org/package/vue-chimera)
[![npm downloads](https://img.shields.io/npm/dt/vue-chimera.svg)](http://npm-stat.com/charts.html?package=vue-chimera)
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/vue-chimera.svg)](https://bundlephobia.com/result?p=vue-chimera@1.0.0)
[![codecov](https://codecov.io/gh/chimera-js/vue-chimera/branch/master/graph/badge.svg)](https://codecov.io/gh/chimera-js/vue-chimera)

VueJS RESTful client with reactive features.
Vue-Chimera is based on [axios](https://github.com/axios/axios) http client library.

Overview of features: 
- Loading flags
- Binding vue instances to API endpoints
- Reactive endpoints and auto request based on vue instance data
- Auto refreshing data
- Serverside prefetching (Nuxt.js compatible)
- Request cancellation
- Cancel all pending requests on vue instance destroy (like route changes)
- Events
- Lightweight

## Demo

[Demo](https://vue-chimera.netlify.com/demo)

## Documents

[Full Documentation](https://vue-chimera.netlify.com)

## Installing

Using npm:

```bash
$ npm install vue-chimera
or
$ yarn add vue-chimera
```

Using cdn:
```html
<script src="https://unpkg.com/vue-chimera@^3.0.0/dist/vue-chimera.min.js"></script>
```

## Getting started

To add **vue-chimera** to your Vue you must use it as a plugin:
*ECMAScript 6*
```javascript
import Vue from 'vue'
import VueChimera from 'vue-chimera'

Vue.use(VueChimera)

```

## Using with Nuxt.js
You can use Vue-Chimera with nuxtjs to use it's SSR features so you can easily prefetch the data.
```javascript
// nuxt.config.js

module.exports = {
  
  modules: [
    'vue-chimera/nuxt'
  ],
  
  chimera: {
    // Enables server side prefetch on endpoints which has `auto` property
    // true: fetched on server
    // false: fetched on client
    // 'override': fetched on server and client (overrided by client)
    prefetch: true,
    
    prefetchTimeout: 2000 // Server side timeout for prefetch
  }
  
}
```

## Maintainer
<p>
<a href="https://github.com/SasanFarrokh" target="_blank" rel="noopener noreferrer"><img src="https://avatars1.githubusercontent.com/u/20913428?s=460&v=4" width="200"></a>
</p>

## Contribution
All PRs are welcome.
Thanks.

## License
[MIT](https://github.com/chimera-js/vue-chimera/blob/master/LICENSE.MD)

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