# mobpie

> _flexible api layer for creating backends with MobX support_

Latest version **0.0.1** (published 2016-12-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install mobpie
pnpm add mobpie
yarn add mobpie
bun add mobpie
```

## 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.0.1 |
| Published | 2016-12-11 |
| First published | 2016-12-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andreas Langecker |
| Maintainers | alangecker |

## Links

- npm: https://www.npmjs.com/package/mobpie
- Repository: https://github.com/alangecker/mobpie
- Homepage: https://github.com/alangecker/mobpie#readme
- Issues: https://github.com/alangecker/mobpie/issues
- npm.io page: https://npm.io/package/mobpie

## Dependencies (2)

- [mobx](https://npm.io/package/mobx.md) ^2.7.0
- [socket.io](https://npm.io/package/socket.io.md) ^1.7.2

## Recent versions

- 0.0.1 (latest) — 2016-12-11

## README

# mobpie
 _flexible api layer for creating backends with MobX support_

### Important!
consider it more as an *concept/draft*, not as a working reliable module. Depending on the interest/feedback I would perhaps work on it.

### Features
- Provides methods on the frontend
which get called on observable changes
- Flexible design to allow different uses

## Example
Full code under [alangecker/mobpie-example](https://github.com/alangecker/mobpie-example)
#### Backend
```js
const MobpieBackend = require('mobpie')
const backend = new MobpieBackend(httpServer)

let text = observable({
  welcome: 'Hello World'
})


backend.register('demo', {
  getText(req) {
    req.send(null, text.welcome)
  },
  setText(req) {
    text.welcome = req.params[0]
    console.log(`set to '${req.params[0]}'`);
  }
})
```

#### Frontend
```js
const api = new Mobpie
api.connect('http://localhost:5000', (err) => {
  api.demo.getText( (err, res) => {
    console.log('current text: '+res)
  })
  api.demo.setText('Hello yunity')
})

```

## API
### Backend

#### `new MobpieBackend(http.Server)`
#### `backend.register(namespace, methods)`
methods get always called with a `Request` instance.
#### `req.send(...args)`
arguments get passed to the frontend callback

### Frontend
#### `new Mobpie()`
#### `api.connect(url, callback)`
#### `api.namespace.method(...args, callback)`
arguments get passed to `req.params` on the backend

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