jatr/js-signals

Custom Event/Messaging system for JavaScript inspired by AS3-Signals

JS-Signals

Custom event/messaging system for JavaScript inspired by AS3-Signals.

For a more in-depth introduction read the JS-Signals Project Page and visit the links below.

Links

• Project Page
• Wiki
• Documentation
• Changelog

License

• MIT License

Distribution Files

Files inside dist folder.

• docs/index.html : Documentation.
• signals.js : Uncompressed source code with comments.
• signals.amd.js : Uncompressed source code wrapped as an asynchronous module to be used together with RequireJS.
• signals.cjs.js : Uncompressed source code wrapped as an CommonJS module to be used on nodejs or any other environment that supports CommonJS modules.
• signals.min.js : Compressed code.

You can install JS-Signals on Node.js using NPM

npm install signals

Repository Structure

Folder Structure

dev       ->  development files
|- build       ->  files used on the build process
|- src         ->  source files
|- tests       ->  unit tests
dist      ->  distribution files
|- docs        ->  documentation

Branches

master      ->  always contain code from the latest stable version
release-**  ->  code canditate for the next stable version (alpha/beta)
develop     ->  main development branch (nightly)
**other**   ->  features/hotfixes/experimental, probably non-stable code

Building your own

This project uses Apache Ant for the build process. If for some reason you need to build a custom version of JS-Signals install Ant and run:

ant build

This will delete all JS files inside the dist folder, merge/update/compress source files, validate generated code using JSLint and copy the output to the dist folder.

IMPORTANT: dist folder always contain the latest version, regular users should not need to run build task.