Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krampstudio/aja.js
Ajax without XML : Asynchronous JavaScript and JavaScript/JSON(P)
https://github.com/krampstudio/aja.js
Last synced: 3 months ago
JSON representation
Ajax without XML : Asynchronous JavaScript and JavaScript/JSON(P)
- Host: GitHub
- URL: https://github.com/krampstudio/aja.js
- Owner: krampstudio
- License: mit
- Created: 2014-09-21T12:57:32.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-01-18T15:21:43.000Z (almost 7 years ago)
- Last Synced: 2024-05-22T22:33:00.741Z (6 months ago)
- Language: JavaScript
- Homepage: http://krampstudio.github.io/aja.js/
- Size: 3.93 MB
- Stars: 305
- Watchers: 11
- Forks: 46
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
aja.js [](https://travis-ci.org/krampstudio/aja.js) [](http://badge.fury.io/js/aja) [](http://gruntjs.com/) [](https://cdnjs.com/libraries/aja)
======
> Ajax without XML : Asynchronous Javascript and JavaScript/JSON(P)
[](https://nodei.co/npm/aja.png?downloads=true&stars=true)
## Basic Sample
Request JSON data
```javascript
aja()
.url('/api/data.json')
.on('success', function(data){
//data is a JavaScript object
})
.go();
```
Load html into an element
```javascript
aja()
.url('/views/page.html')
.into('.container')
.go();
```
More options using the fluent api, terrific REST client.
```javascript
aja()
.method('GET')
.url('/api/customer')
.timeout(2500)
.data({firstname: 'John Romuald'})
.on('200', function(response){
//well done
})
.on('timeout', functon(){
// uh oh... Request ended. Do something fancy here, don't let your user wait forever!
})
.go();
aja()
.method('PUT')
.url('/api/customer')
.cache(false)
.body({id : 12, firstname: 'John Romuald', job : 'linguist'})
.on('200', function(response){
//well done
})
.on('40x', function(response){
//something is definitely wrong
})
.on('500', function(response){
//oh crap
})
.go();
```
JSONP
```javascript
aja()
.url('http://otherdomain.com/api/remoteScript')
.type('jsonp')
.jsonPaddingName('callbackParameter')
.jsonPadding('someGlobalFunction')
.on('success', function(data){
//Fuk cross origin policy
})
.go();
```
Raw script loading
```javascript
aja()
.url('http://platform.twitter.com/widgets.js')
.type('script')
.on('success', function(){
window.twttr.widgets.load();
})
.go();
```
## Development
### Setup
You need [grunt >= 0.4][grunt] as well as [node] and [npm] installed and running on your system.
```
git clone https://github.com/krampstudio/aja.js.git
cd aja.js
npm install
```
### Tests
Run the tests:
```
grunt test
```
### Development
The dev of this library is based on TDD principle. So, dev means *write tests*. Run the developent server :
```
grunt devtest
```
So tests run once something is modified and you can access it also at http://localhost:9901/test
## Contributing
Contributions (issue reporting, bug fixes, feedback, typos, gimie a tip, etc.) are really welcomed!
This library is developed using the TDD principles, so I accept pull request only if they come with the according unit/integration test.
> I'd love if somebody can create a nice logo for aja.js...
## History
- _0.1.0_ : initial release
- _0.2.0_ : added support of new HTTP methods (trace, patch and connect)
- _0.2.1_ : Fix missing `main` prop in package.json
- _0.3.0_ : support new request type : script
- _0.3.1_ : Fix issue #4 and cache management
- _0.3.2_ : Fix issue #7
- _0.3.3_ : Fix issue #10 and #11
- _0.3.4_ : reminify
- _0.4.0_ : added timeout
- _0.4.1_ : Merge PR #16
## License
Copyright (c) 2014 Bertrand Chevrier `<"chevrier_bertrand gmail_com".replace(/\s/, '@').replace(/_/g, '.')>`
Licensed under the MIT license.
[grunt]: https://gruntjs.com
[node]: http://nodejs.org
[npm]: http://npmjs.org