msg-channel-shake v0.0.7

Overview

Installation

npm install msg-channel-shake

Usage

The package exports a couple of entrypoints, we'll go over them and when to use each

Initiators

Can be imported from msg-channel-shake/initiators. The initiators are the context that initials the communication, it can either be an iframe or a WebWorker.

IframeMessageChannelInitiator

• Type: ( options: MessageChannelInitiatorOptions, iframeReceiverWindow: Window ) => IframeMessageChannelInitiator

import { IframeMessageChannelInitiator } from "msg-channel-shake/initiators";

const messageChannelInitiator = new IframeMessageChannelInitiator(
  {
    channelId,
    async messageCallback({ type, payload }) {
      switch (type) {
        case "Event from receiver": {
          // Logic, can be async, can throw error as well
          break;
        }
      }
    },
  },
  iframe.contentWindow!
);

IframeMessageChannelInitiator.initiateHandshake

• Type (timeout: number) => Promise<void>

IframeMessageChannelInitiator.messaging.sendMessage

Send a message to the receiver waiting for timeoutMs until a response

• Type <T = unknown>( message: { type: string; payload: unknown; }, timeout?: number ): Promise<T>

const responseFromReceiver = await;
messageChannelInitiator.messaging.sendMessage({
  type: "message from initiator",
  payload: {
    hello: "world",
  },
});

IframeMessageChannelInitiator.messaging.sendAsyncMessage

Send a message without expecting a response

• Type <T = unknown>( message: { type: string; payload: unknown; } ): void

Receivers

Can be imported from msg-channel-shake/receivers. The receivers are the context that the initiator is a parent of, it can either be an iframe or a WebWorker.

WindowMessageChannelReceiver

• Type: ( options: MessageChannelInitiatorOptions, iframeReceiverWindow: Window ) => IframeMessageChannelInitiator

import { WindowMessageChannelReceiver } from "msg-channel-shake/receivers";

const messageChannelReceiver = new WindowMessageChannelReceiver({
  channelId,
  async messageCallback(payload) {
    switch (payload.type) {
      case "Event from initiators": {
        let response;
        // do logic
        return response;
      }
    }
  },
});

WindowMessageChannelReceiver.waitForHandshake

• Type (timeout: number) => Promise<void>

WindowMessageChannelReceiver.messaging.sendMessage

Send a message to the initiator waiting for timeoutMs until a response

• Type <T = unknown>( message: { type: string; payload: unknown; }, timeout?: number ): Promise<T>

await messageChannelReceiver.messaging.sendMessage({
  type: "message from receiver",
  payload: {
    hello: "world",
  },
});

WindowMessageChannelReceiver.messaging.sendAsyncMessage

Send a message without expecting a response

• Type <T = unknown>( message: { type: string; payload: unknown; } ): void

Examples

See the examples folder for usages

• vanilla js example
• react example