# gun-exec

> Execute Gun.js API via structured data

Latest version **0.1.1** (published 2017-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install gun-exec
pnpm add gun-exec
yarn add gun-exec
bun add gun-exec
```

## 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.1 |
| Published | 2017-03-29 |
| First published | 2017-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Kristian Mandrup |
| Maintainers | kmandrup |
| Keywords | gun, edge, db, dsl, api, extension, chaining |

## Links

- npm: https://www.npmjs.com/package/gun-exec
- Repository: https://github.com/kristianmandrup/gun-exec
- Homepage: https://github.com/kristianmandrup/gun-exec#readme
- Issues: https://github.com/kristianmandrup/gun-exec/issues
- npm.io page: https://npm.io/package/gun-exec

## Dependencies (1)

- [gun](https://npm.io/package/gun.md) ^0.6.1

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2017-03-29
- 0.1.0 — 2017-03-29

## README

# Gun data API executer

![gun-exec](https://github.com/kristianmandrup/gun-exec/raw/master/army-guy.jpg)

Execute [Gun.js](gun.js.org) API via structured data.

## Why

A structured data API is useful for clients who don't have direct access to the `gun` instance or the Javascript environment.

The "raison d'être" was an attempt to use Gun from Elm, a foreign client environment. With gun exec we can do:

```js
let execute = createExec(Gun(), {logging: true})

app.ports.gunCommander.subscribe(function (command) {
  console.log('gun command from elm', command)
  // execute command via gun-exec
  execute(command)
})
```

## Install

npm: `npm i -S gun-exec` (soon)

yarn: `yarn add gun-exec` (soon)

from github: `npm i -S kristianmandrup/gun-exec`

### Dependencies

- `gun` v. 0.6 or higher

## Usage

Assumes [Babel.js](https://babeljs.io) or similar transpiler setup

```js
import Gun from 'gun/gun'
import createExec from 'gun-exec'
const gun = Gun();

let execute = createExec(gun, {
    // default options for each execute context
    logging: true
  })

// equivalent to: gun.get('colors').put({color: 'blue'})
execute(gun, [{
  get: 'colors'
}, {
  put: {
    color: 'blue'
  }
}])

let cols = execute(gun, {
  get: 'colors'
})
// ...
```

Using structured commands in the form `name` and `args`

```js
  execute(gun, [{
    name: 'get',
    args: 'colors'
  }, {
    name: 'val',
    args: [cb]
  }])
```

For mutations such as `set` and `put` you can use explicit `model` option

```js
  execute(gun, [{
    name: 'get',
    args: 'colors'
  }, {
    name: 'put',
    model: myColors
  }])
```

You can mix and match these command declaration variants as you like

Special options:

- `root: true` : resets the chain context to the gun instance.

### Advanced example

```js
  let blue = execute(gun, [{
    get: 'kris'
  }, {
    put: {
      name: 'kris',
      role: 'developer'
    },
  }, {
    get: 'kris',
    root: true
  }, {
    val: cbEnd
  }], {
    // override options for this execution context
    logging: false
  })
```

Here we override the logging setting of this `execute` context via `logging: false` option in the final (optional) argument.

## Elm usage

See [Elm usage example](https://github.com/kristianmandrup/gun-exec/blob/master/Elm-usage.md)

An Elm example app can be found in [examples/user](https://github.com/kristianmandrup/gun-exec/blob/master/examples/user)

![bad ass](https://github.com/kristianmandrup/gun-exec/raw/master/bad-ass.jpg)

## Contributing

Install dependency modules/packages

`npm i`

### Compile/Build

The project includes a `gulpfile` configured to use Babel 6.
All `/src` files are compiled to `/dist` including source maps.

Scripts:

- start: `npm start`
- build: `npm run build` (ie. compile)
- watch and start: `npm run watch`
- watch and build: `npm run watch:b`

### Run Tests

`npm test` or simply `ava test`

## License

MIT Kristian Mandrup

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