aurelia-flux v0.1.6
aurelia-flux
A Flux plugin for Aurelia that supports Promises.
import {inject} from 'aurelia-framework';
import {Dispatcher, handle, waitFor} from 'aurelia-flux';
@inject(Dispatcher)
class MessagesStore {
messages = [];
constructor(dispatcher) {
this.dispatcher = dispatcher;
}
@handle('message.submit')
collect(action, message) {
return new Promise((resolve) => {
setTimeout(() => {
this.messages.push(message);
this.dispatcher.dispatch('message.submitted', message);
resolve();
}, 1000);
});
}
getMessages() {
return this.messages;
}
}
@inject(Dispatcher, MessagesStore)
export class Welcome {
message = "Hello Aurelia!";
constructor(dispatcher, store) {
this.dispatcher = dispatcher;
this.store = store;
this.dispatcher.handle('message.submitted', (action, message) => {
alert(message);
});
}
submit() {
this.dispatcher.dispatch('message.submit', this.message);
}
@handle('message.*')
@waitFor(MessagesStore)
logMessage(action, message) {
console.log(event, message);
}
}
Dependencies
Used By
This library isn't used by Aurelia. It is an optional plugin.
Platform Support
This library can be used in the browser only.
Building The Code
To build the code, follow these steps.
- Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
From the project folder, execute the following command:
npm install
Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
To build the code, you can now run:
gulp build
You will find the compiled code in the
dist
folder, available in three module formats: AMD, CommonJS and ES6.See
gulpfile.js
for other tasks related to generating the docs and linting.
Running The Tests
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
Install the client-side dependencies with jspm:
jspm install
You can now run the tests with this command:
karma start