With XHook, you could easily implement functionality to:
- Cache requests in memory, localStorage, etc.
- Insert authentication headers
- S3 Request Signing, see S3 Hook
- Simulate responses
- Create fake transparent backends for testing purposes
- Sending Error statistics to Google Analytics
- Create a client-side alternative to CORS by offloading requests to an iframe then splicing the response back in, see XDomain
- Devious practical jokes
- Supports RequiresJS and Browserify
- Preflight GZip compression, see XZip (Incomplete)
- Intercept and modify XMLHttpRequest ("AJAX") request and response
- Simulate responses transparently
- Backwards compatible
addEventListener
removeEventListener
- Backwards compatible user controlled progress (download/upload) events
-
Add BrowserSwarm or TestlingCI automated cross-browser tests
Tip: See CONTRIBUTING.md for steps on how to contribute 😉
Here, we're converting vowels to z's in all requests to 'example.txt':
//modify 'responseText' of 'example2.txt'
xhook.after(function(request, response) {
if(request.url.match(/example\.txt$/))
response.text = response.text.replace(/[aeiou]/g,'z');
});
Tested in IE8+, Chrome, Firefox, Safari
Run test suite here: http://jpillora.com/xhook/test
XMLHttpRequest
before XHook can patch it
-
Development xhook.js 14KB
-
Production xhook.min.js 6KB
-
CDN
- Latest version (Cloudflare CDN to "
master
" branch)
<script src="//jpillora.com/xhook/dist/xhook.min.js"></script>
- Lock particular version (Rawgit CDN to any release tag)
<script src="//cdn.rawgit.com/jpillora/xhook/1.3.1/dist/xhook.min.js"></script>
- Latest version (Cloudflare CDN to "
Modifying any property of the request
object will modify the underlying XHR before it is sent.
To make the handler
is asynchronous, just include the optional callback
function, which accepts an optional response
object.
To provide a fake response, return
or callback()
a response
object.
Modifying any property of the response
object will modify the underlying XHR before it is received.
To make the handler
is asynchronous, just include the optional callback
function.
Enables XHook (swaps out the native XMLHttpRequest
class). XHook is enabled be default.
Disables XHook (swaps the native XMLHttpRequest
class back in)
method
(String) (open(method,url)
)url
(String) (open(method,url)
)body
(String) (send(body)
)headers
(Object) (Contains Name-Value pairs set withsetRequestHeader(name,value)
)timeout
(Number) (timeout
)type
(String) (responseType
)withCredentials
(String) (withCredentials
)
status
(Number) Required when for fakeresponse
s (status
)statusText
(String) (statusText
)text
(String) (responseText
)headers
(Object) (Contains Name-Value pairs retrieved withgetAllResponseHeaders()
)xml
(XML) (responseXML
)data
(Varies) (response
)
The dark red before
hook is returning a response
object, which will trigger the after
hooks, then trigger the appropriate events, so it appears as if response
came from
the server.
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
http://www.w3.org/TR/XMLHttpRequest/
http://www.w3.org/TR/XMLHttpRequest2/
-
XHook does not attempt to resolve any browser compatibility issues. Libraries like jQuery and https://github.com/ilinsky/xmlhttprequest will attempt to do this. XHook simply proxies to and from
XMLHttpRequest
, so you may use any library conjunction with XHook, just make sure to load XHook first. -
You may use synchronous XHR, though this will cause asynchronous hooks to be skipped.
See CONTRIBUTING for instructions on how to build and run XHook locally.
Contributors:
- Jaime Pillora [email protected]
- Daniel Gasienica [email protected]
Copyright © 2014 Jaime Pillora [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.