Package Exports
- fresource
- fresource/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fresource) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Install
With npm:
$ npm i fresource --save
Via CDN:
<script src="https://unpkg.com/fresource/dist/fresource.js"></script>
Usage
var fresource = require('fresource')
var Users = fresource('/api/users/:id?sort=:sort')
Users.get({ sort: 'name' }) // will fetch /api/users?sort=name
.then(result => {
var users = result
})
Users.get({ id: 1 }) // will fetch /api/users/1
.then(result => {
var user = result
})
API
Collection = fresource(path)
Initialize a resource with a path / url. Path should include all path / query parameter variables like :key
.
Collection.get(params)
Fetches a GET
request with given parameters.
Returns promise.
Collection.save(params)
Sends a POST
request with given parameters. Residual parameters that are not used in url will be posted in body.
Returns promise.
Collection.update(params)
Sends a PUT
request with given parameters. Residual parameters that are not used in url will be posted in body.
Returns promise.
Collection.delete(params)
Sends a DELETE
request with given parameters.
Returns promise.
Author
Ismail Demirbilek @dbtek
License
MIT