Portal-gun NPM

Portal-Gun

An iframe rpc library

Install

$ npm install portal-gun

API

PortalGun = require 'portal-gun'

portal = new PortalGun({
  isParentValidFn: (origin) ->
    return origin is 'http://x.com'
})

portal.listen()

portal.on 'methodName', (what) -> "#{what}?"

portal.call 'methodName', 'hello'
.then (result) -> # 'hello?'

###
# @param {Object} config
# @param {Number} [config.timeout=3000] - request timeout (ms)
# @param {Function<Boolean>} config.isParentValidFn - restrict parent origin
###
constructor: ({timeout, @isParentValidFn} = {}) -> null

# Binds global message listener
# Must be called before .call()
listen: =>

###
# @param {String} method
# @param {...*} params
# @returns Promise
###
call: (method, params...) =>

###
# Register method to be called on child request, or local request fallback
# @param {String} method
# @param {Function} fn
###
on: (method, fn) =>