minimally

minimally

Minimal key-value store and event subscription

Inspired by https://github.com/developit/mitt/

• Microscopic: weighs about 200 bytes gzipped
• Functional: methods don't rely on this
• Great Name: somehow minimally wasn't taken

minimally was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+.

Table of Contents

• Install
• Usage
• Examples & Demos
• API
• Contribute
• License

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

$ npm install --save minimally

Then with a module bundler like rollup or webpack, use as you would anything else:

// using ES6 modules
import minimally from 'minimally'

// using CommonJS modules
var minimally = require('minimally')

The UMD build is also available on unpkg:

<script src="https://unpkg.com/minimally/dist/minimally.umd.js"></script>

You can find the library on window.minimally.

Usage

import minimally from 'minimally'

const model = minimally()

// listen to an event
model.on('foo', e => console.log('foo', e) )

// Set value for key and dispatch event to subscribers
const val = { a: 'b' }
model.set('foo', val)

// Get value for key
m.get(key) === val

// working with handler references:
function onFoo() {}
model.on('foo', onFoo)   // listen
model.off('foo', onFoo)  // unlisten

API

Table of Contents

• minimally
• get
  • Parameters
• on
  • Parameters
• off
  • Parameters
• set
  • Parameters

minimally

minimally: Minimal key-value store and event subscription.

Returns minimally

get

Get current value for key

Parameters

• key (String | Number) Key for which to lookup value

Returns any

on

Subscribe to events for key with event handler

Parameters

• key (String | Number) Type of event to listen for
• fn Function Function to call in response to given event

Returns void

off

Release subscription for key and event handler

Parameters

• key (String | Number) Type of event to unregister fn from
• fn Function Handler function to remove

Returns void

set

Set value for key and dispatch event to subscribers

Parameters

• key (String | Number) The event type to invoke
• val any? Any value (object is recommended and powerful), passed to each handler

Returns void

Contribute

First off, thanks for taking the time to contribute! Now, take a moment to be sure your contributions make sense to everyone else.

Development Start:

This project is typed with Flow Type annotations. To ensure you have the proper typings for this project run

flow-typed install

Reporting Issues

Found a problem? Want a new feature? First of all see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

• Fork it!
• Clone your fork: git clone https://github.com/<your-username>/minimally
• Navigate to the newly cloned directory: cd minimally
• Create a new branch for the new feature: git checkout -b my-new-feature
• Install the tools necessary for development: npm install
• Make your changes.
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request with full remarks documenting your changes.

License

MIT License © Mikael Sand