cordova-plugin-xhr-local-file

0.0.6 • Public • Published

cordova-plugin-xhr-local-file

This plugin is a polyfill for XmlHTTPRequest that will handle the file:// protocol correctly using Cordova's File API behind the scenes.

Installation

$ cordova plugin add cordova-plugin-xhr-local-file
$ cordova prepare

Usage

You may now make XHR requests to local files. Moreover, other JS libraries that load assets via XHR will now function normally even when loading assets from your Cordova app's filesystem.

Since Cordova apps are loaded from file://, every relative URL uses the file:// protocol. This library resolves relative and absolute URLs using the Cordova www folder as the webroot.

var oReq = new XMLHttpRequest()
oReq.open('GET', './foo.json') // If you are in ./www/index.html, this resolves to ./www/foo.json
oReq.send()
var oReq = new XMLHttpRequest()
oReq.open('GET', '/foo.json') // If you are in ./www/index.html, this ralso esolves to ./www/foo.json
oReq.send()

cdvfile:// protocol is also honored:

var oReq = new XMLHttpRequest()
oReq.open('GET', 'cdvfile://localhost/bundle/www/data/foo.json')
oReq.send()

Thanks

Thanks to Oracle for their XHR polyfill implementation, upon which this one is based.

Package Sidebar

Install

npm i cordova-plugin-xhr-local-file

Weekly Downloads

6

Version

0.0.6

License

UPL

Unpacked Size

140 kB

Total Files

10

Last publish

Collaborators

  • benallfree