!Seneca
> A [Seneca.js][] utility plugin

seneca-basic

[![npm version][npm-badge]][npm-url]
[![Dependency Status][david-badge]][david-url]
[![Build Status][travis-badge]][travis-url]
[![Coveralls][BadgeCoveralls]][Coveralls]
[![Gitter chat][gitter-badge]][gitter-url]

This plugin is included with the main seneca module and provides a
small set of basic utility action patterns.

If you're using this module, and need help, you can:

- Post a github issue
- Tweet to @senecajs
- Ask on the [Gitter][gitter-url]

seneca-basic's source can be read in an annotated fashion by,
- running npm run annotate
- viewing online

The annotated source can be found locally at ./doc/seneca-basic.html.

$3

Supports Seneca versions 1.x - 3.x

Install

This plugin module is included in the main Seneca module.

``sh
npm install seneca
`

$3

To explicitly install separately,

`sh
npm install seneca-basic
`

And in your code:

`js
var seneca = require('seneca')({
default_plugins: {
'basic': false
}
})

seneca.use(require('seneca-basic'))
`

Action Patterns

$3

Set a note value. Notes are a simple internal per-process
communication mechanism for plugins to exchange data. In particular,
plugins can set keyed values before the plugin that uses the data
reads it. See [seneca-admin][seneca-admin] for an example.

_Parameters_

* key: string; key name
* value: key value

_Response:_

* None.




$3

Get a note value.

_Parameters_

* key: string; key name

_Response:_

* value: key value, if defined




$3

Push a note value onto a list. The namespace for lists is separate
from the namespace for single values. The list is created if it does not exist.

_Parameters_

* key: string; key name
* value: value to append to list.

_Response:_

* None.




$3

Get the full list of values for the key, in pushed order.

_Parameters_

* key: string; key name

_Response:_

* Array of values.




$3

Get the last value of a list, and remove it from the list.

_Parameters_

* key: string; key name

_Response:_

* value: key value, if list was non-empty




Releases

- 0.3.0: 2015-06-15: Normalized _note_ patterns. Prep for Seneca 0.6.2.

Contributing

The [Senecajs org][] encourage open participation. If you feel you can help in any way, be it with
documentation, examples, extra testing, or new features please get in touch.

Test

To run tests, simply use npm:

`sh
npm run test
``

License

Copyright (c) 2014 - 2016, Richard Rodger and other contributors.
Licensed under [MIT][].

[travis-badge]: https://travis-ci.org/senecajs/seneca-basic.svg?branch=master
[travis-url]: https://travis-ci.org/senecajs/seneca-basic
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[gitter-url]: https://gitter.im/senecajs/seneca
[npm-badge]: https://img.shields.io/npm/v/seneca-basic.svg
[npm-url]: https://npmjs.com/package/seneca-basic
[david-badge]: https://david-dm.org/senecajs/seneca-basic.svg
[david-url]: https://david-dm.org/senecajs/seneca-basic
[Coveralls]: https://coveralls.io/github/senecajs/seneca-basic?branch=master
[BadgeCoveralls]: https://coveralls.io/repos/github/senecajs/seneca-basic/badge.svg?branch=master
[MIT]: ./LICENSE
[Senecajs org]: https://github.com/senecajs/
[Seneca.js]: https://www.npmjs.com/package/seneca
[senecajs.org]: http://senecajs.org/
[github issue]: https://github.com/senecajs/seneca-basic/issues
[@senecajs]: http://twitter.com/senecajs
[seneca-admin]: https://github.com/senecajs/seneca-admin