https://github.com/rich-97/req-ajax
Standalone library for ajax requests.
https://github.com/rich-97/req-ajax
ajax ajax-request browser front-end javascript json-string req-ajax shorthand standalone-library webpack
Last synced: 30 days ago
JSON representation
Standalone library for ajax requests.
- Host: GitHub
- URL: https://github.com/rich-97/req-ajax
- Owner: rich-97
- License: mit
- Created: 2017-03-07T21:56:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-20T22:12:20.000Z (about 8 years ago)
- Last Synced: 2024-11-19T11:52:36.461Z (over 1 year ago)
- Topics: ajax, ajax-request, browser, front-end, javascript, json-string, req-ajax, shorthand, standalone-library, webpack
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# req-ajax
[](https://www.npmjs.com/package/req-ajax)
[](https://www.npmjs.com/package/req-ajax)
Standalone library for ajax requests.
## Installation
Execute this command in your project for install the package:
`npm install req-ajax --save`
## Usage
Simple external script in your **html** file:
```html
```
Also this can be used with `webpack` just require the module `req-ajax`.
## API documentation
### Ajax constructor
`new Ajax(config)`
the **config** object:
#### Properties
- `url` - **{String}** is required.
- `method` - **{String}** is required.
- `params` - **{Object}** is optional, this property is for specific queries. The queries like this `foo=bar&bar=foo` can be transformed to `{ foo: 'bar', bar: 'foo' }` in the JavaScript object notation, so is much better for make queries and easy.
- `fragment` - **{String}** is optional, without the `#` character.
#### Methods
- `success(response)` - **{Function}** is optional.
- `error(status, headers)` - **{Funcion}** is optional.
## Test
For the unit-test install the `devDependencies` and open the file `test/index.html` in your browser.
## License
[MIT](https://github.com/rich-97/req-ajax/blob/master/LICENSE)