Need private packages and team management tools?Check out npm Teams »

xdls

0.1.9 • Public • Published

XDLS - Cross-Domain Local Storage

Allows for storing data across domains.

Eg:

var XDLS = require( 'xdls' );
 
var xdls = new XDLS( {
    origin: 'http://yourdomain.com',
    path: '/xdls.html'
} );
 
xdls.setItem( 'key', 'value', function( error ) {
    if ( error ) {
        console.error( error );
        return;
    }
 
    console.log( 'key/value stored into yourdomain.com' );
 
    xdls.getItem( 'key', function( error, value ) {
        if ( error ) {
            console.error( error );
            return;
        }
        
        console.log( 'got value from yourdomain.com: ' + value );
    } );
} );
 

METHODS

XDLS is effectively a wrapper around localforage:

getItem

Gets the specified item:

xdls.getItem( 'foo', function( error, value ) {
    if ( error ) {
        console.error( error );
        return;
    }
    
    console.log( 'foo: ' + value );
} );

setItem

Sets the specified item:

xdls.setItem( 'foo', JSON.stringify( { yak: 'baz' } ), function( error ) {
    if ( error ) {
        console.error( error );
    }
} );

removeItem

Removes the specified item:

xdls.removeItem( 'foo', function( error ) {
    if ( error ) {
        console.error( error );
    }
} );

clear

Clears all items:

xdls.clear( function( error ) {
    if ( error ) {
        console.error( error );
    }
} );

length

Gets the number of keys stored:

xdls.length( function( error, len ) {
    if ( error ) {
        console.error( error );
        return;
    }
 
    console.log( 'Num keys: ' + len );
} );

keys

Gets a list of keys in storage:

xdls.keys( function( error, keys ) {
    if ( error ) {
        console.error( error );
        return;
    }
 
    console.log( 'keys:\n' + keys.join( '\n' ) );
} );

INSTALLATION

You'll need to place xdls.html somewhere on the domain you'd like to use to share data. Then, in whatever client code you're developing, you'll need to include XDLS via something like browserify.

HOW IT WORKS

When you include XDLS into your client code running on a different domain and initialize it to point at your shared/storage domain, it will create an iframe which loads up xdls.html. That iframe can now store data for that domain using localforage.

When you call the various localforage methods on the local XDLS instance, it will send messages to the iframe, which will proxy them to/from localForage on your shared domain.

WHY YOU MIGHT NEED XDLS

Let's say you make a nice embeddable widget that people can use to show something from your web service on their page. If you want to store any local data, it would be associated with each individual domain that has embedded you.

However, with XDLS you can store that data into your own domain's local storage, which means it can be shared by anyone who's embedded your widget (and with your own site).

Install

npm i xdls

DownloadsWeekly Downloads

2

Version

0.1.9

License

MIT

Last publish

Collaborators

  • avatar
  • avatar