https://github.com/niieani/aurelia-async-binding-function
An Aurelia plugin that allows you to bind to Promises
https://github.com/niieani/aurelia-async-binding-function
Last synced: 6 months ago
JSON representation
An Aurelia plugin that allows you to bind to Promises
- Host: GitHub
- URL: https://github.com/niieani/aurelia-async-binding-function
- Owner: niieani
- Created: 2016-03-23T20:30:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:35:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-03T11:42:44.937Z (6 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aurelia-async-binding-function
An Aurelia plugin that allows you to bind to Promises.
## How to install this plugin?
1. In your project install the plugin and `aurelia-binding-functions` via `jspm` with following command
```shell
jspm install npm:aurelia-async-binding-function npm:aurelia-binding-functions
```
2. Make Aurelia load the plugin by adding the following line to the `configure` function in the `main.js` file of your `src` folder
```diff
export function configure(aurelia) {
aurelia.use
.standardConfiguration()
.developmentLogging();
+ aurelia.use.plugin('aurelia-binding-functions');
+ aurelia.use.plugin('aurelia-async-binding-function');
aurelia.start().then(a => a.setRoot());
}
```
3. If you use TypeScript or use Visual Studio Code the type declarations for `aurelia-async-binding-function` should be visible automatically.
## Using the plugin (example)
View:
```html
${ @async(myPromise) }
```
ViewModel:
```js
export class AsyncExample {
myPromise = new Promise((resolve) => setTimeout(() => resolve('hello'), 2000))
}
```
## Dependencies
* [aurelia-binding-functions](https://github.com/niieani/aurelia-binding-functions)
## Used By
This library isn't used by Aurelia. It is an optional plugin.
## Platform Support
This library can be used in the **browser** as well as on the **server**.
## Building The Code
To build the code, follow these steps.
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:
```shell
npm install -g gulp
```
4. To build the code, you can now run:
```shell
gulp build
```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
6. 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:
1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
```shell
npm install -g karma-cli
```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
```shell
npm install -g jspm
```
3. Install the client-side dependencies with jspm:
```shell
jspm install
```
4. You can now run the tests with this command:
```shell
karma start
```