Created to simplify calls with Aurelia HttpClient. The @rest decorator adds CRUD methods to es6 classes.
Define an entity class.
class RequestInterceptor {
request(message) {
return message;
}
requestError(error) {
return error;
}
}
class ResponseInterceptor {
response(message) {
return message;
}
responseError(error) {
return error;
}
}
@rest('http://example.com/api/user/:id', {
params: { 'id': '@id' },
headers: {
'Authorization': 'Token 9a8b7c6e5f4g3h2i1jk09a8b7c6e5f4g3h2i1jk0'
},
interceptors: [
new RequestInterceptor(),
new ResponseInterceptor()
]
})
class User {
name;
constructor(name) {
this.name = name;
}
resolve() {
}
}
RESTful methods of class User will request http://example.com/api/user/ on all calls.
var user = new User('Fulano');
The promise resolution of methods create and update update the user, and return the user instance.
user.create()
.then((userInstance) => {
// do something else with user
// userInstance === user
});
Ex.:
user.name = 'Sicrano';
user.update()
.then((userInstance) => {
// do something else with user
// userInstance === user
});
Destroy method removes all properties and property values of the user instance. It can't destroy the user instance object since 'this' object is immutable.
user.destroy()
.then(() => {
// do something
// works on non strict mode
delete user;
});
Ex.: Lookup an user with id 1.
User.get({ id: 1 })
.then((userInstance) => {
// do something with user
});
Ex.: Lookup users with name equal to 'Beltrano'.
User.query({ name: 'Beltrano' })
.then((list) => {
// do something with Array<User>
});
- None
- aurelia-http-client
This library is used directly by applications only.
This library can be used in the browser only.
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
distfolder, available in three module formats: AMD, CommonJS and ES6. -
See
gulpfile.jsfor other tasks related to generating the docs and linting.
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