Giter Club home page Giter Club logo

postmessage-plus's Introduction

postmessage-plus Build Status

Simple postmessage library. Provides a common API for interacting the window.postMessage and security against listening to dangerous messages.

Generally, window communications take the form of a client/server interaction. The client window sends messages to the server. The server listens to one or more client's messages.

postmessage-plus supports client-server as well as client-client interactions.

How to use

Here is a standard setup

Server

// Create an instance
var pm = new PMPlus({
  listenDomain: 'http://clientDomain.com' // string, array or regex
});

// Listen to a channel
pm.listen('myChannel', function(data, respond) {
  //... do something async or sync
  
  respond(
    true,  // true for success, false for error
    'Got your message' // Response or Error
  );
});

Client

// Create an instance
var pm = new PMPlus({
  sendDomain: 'http://serverDomain.com' 
  // only string allowed, default that can be changed on individual messages
});

// Send a message
pm.send({
  w: iframe.contentWindow // window reference
  channel: 'myChannel',
  data: 'Here you go',
  callback: function(success, info) {
    if(success) {
      console.log('Sucess: ', info);
    } else {
      console.log('Error: ', info);
    }
  }
});

A single window can be both a server and a client. To send and receive messages, use sendDomain and listenDomain.

postmessage-plus's People

Contributors

taylorhakes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.