miniflux

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 8)

A Small Boilerplate-Free Flux(ish) Library for React Apps

miniflux Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

miniflux
========

[![Build Status](https://travis-ci.org/dfrnswrth/miniflux.svg?branch=master)](https://travis-ci.org/dfrnswrth/miniflux)

**A Small Boilerplate-Free Flux(ish) Library for React Apps**

[JSBin](http://dfrnswrth.jsbin.com/gafaje)

Overview
--------

`npm install --save miniflux`

Examples below assume browserify. `dist/` contains standalone builds if that's what you need.

Create a store with some initial state, and register any action handlers and callbacks.

```js
var Flux = require('miniflux');

var initialState = {foo: 'bar'};
var MyStore = Flux.Store(initialState)
  .registerHandler('myAction', handleAction)
  .registerHandler('anotherAction', [foo, bar, baz])
  .registerCallback(aCallback);

function handleAction() {
  // called when miniflux dispatches `myAction`
  // `this` is the instance of miniflux.Store
  this.state.foo = 'baz';
}

function aCallback() {
  // called after the store handles any action
  // before `miniflux.change` is emitted.
  this.state.lastChanged = new Date();
}
```

Then interact with the store in your React components:

```js
var Flux = require('miniflux');
var MyStore = require('./path/to/mystore');

API
---
### `Flux.change`
Change event. Defaults to 'change';

### `miniflux.Store([state, [changeEvent]])`
Returns a store instance.

`state`: the initial state of the store
`changeEvent`: name || type of event to be emitted. Defaults to 'change'.

##### `#registerHandler(name, method)`
`name`: *string* name of action to handle    
`method`: *function of array of functions* that handle the action. Context is bound to the store instance being handled.

if `method` returns `false`, the store responding to event `name` will not emit envoking all action handlers.

##### `#registerCallback(method)`
`method`: *function* called before each change event is emitted. Bound to the store context.

*note*: Action handlers and callbacks may be associated with multiple stores.

##### `#currentState()`
Returns the current value of `state`

##### `#destroy()`
Removes the store from the miniflux registry.

### `miniflux.Action(action)`
Checks all stores for handlers assigned to `action`. If `action` is handled by a store, that stores callbacks (if any) are called, followed by the store emitting the `miniflux.change` event. Throws an error is nothing handles `action`.

LICENSE
-------
MIT

miniflux

miniflux Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

miniflux

miniflux Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README