# vue-factory

> A factory/provider/service extension for vue.js

Latest version **0.1.6** (published 2017-02-13) · MIT license · 0 weekly downloads

## Install

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

## 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.1.6 |
| Published | 2017-02-13 |
| First published | 2016-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 28 |
| Author | Yewei |
| Maintainers | yewei |

## Links

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

## Recent versions

- 0.1.6 (latest) — 2017-02-13
- 0.1.5 — 2017-02-10
- 0.1.4 — 2017-01-20
- 0.1.3 — 2017-01-11
- 0.1.2 — 2017-01-09
- 0.1.1 — 2016-12-01
- 0.1.0 — 2016-11-21
- 0.0.1 — 2016-11-16

## README

# vue-factory

A factory/provider/service extension for vue.js

## Requirements

*  Vue 2.x
*  Vue 1.x not tested
*  Proxy/Reflect compatible browser for full features

## Installation

Install through npm

```
npm install vue-factory
```

Include vue-factory in <body> after loading Vue and it will automatically hooked

```
<script src="/path/to/vue-factory.js'"></script>
```

Or with Webpack/Browserify projects, add these lines in your main.js

```
var Vue = require('vue');
var VueFactory = require('vue-factory');

Vue.use(VueFactory);
```

## Useage

1.  write a factory Class/function:

    ```
    class FactoryExample {
      constructor () {
        this.const = 'not editable'
      }
      echo (something) {
        console.log(something)
      }
      get prop () {
        return 'get: ' + this.value
      }
      set prop (value) {
        this.value = value
      }
    }
    ```

    you can use *this.$Vue* in the factory Class to access the The global Vue API. For example, when working along with vue-resouce, *this.$Vue.http* is equivalent to *Vue.http*.

2.  register the factory Class:

    ```
    Vue.factory.register({
      'example': FactoryExample
    })
    ```

3.  declare providers that will be injected in the Vue component:

    as in a .vue file

    ```
    <script>
    ...
    export default {
       ...
       providers: ['example'],
       ...
    }
    ...
    </script>
    ```

4.  then, you can access the provider in the component using:

    ```
    this.example.echo("ok") // "ok"
    this.example.prop // get: undefined
    this.example.prop = "changed"
    this.example.prop // get: changed
    ```

    note that all of the providers are **Singletons**, if you inject the *example* provider into other components later, *this.example.prop* will get **changed** value.

## Demo

Basic Example: [Github](https://github.com/ye-will/vue-factory/tree/master/example)  
Working with Vuex: [JSFiddle](https://jsfiddle.net/ye_well/dcmxfcz3/)

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