hermes

Javascript messaging library

Installation

npm i @wemnyelezxnpm/odit-nostrum-expedita or yarn add @wemnyelezxnpm/odit-nostrum-expedita

Usage

The main concept is sending messages via MessageClient's and answering them via MessageHost's.

---

Iframe

Send and recieve messages accross iframes and parent windows

1// inside iframe
2import { IframeMessageClient, Request } from '@wemnyelezxnpm/odit-nostrum-expedita/iframe';
3
4class MessageSenderService extends IframeMessageClient {
5  @Request('hello')
6  public sayHello(name: string): Observable<string> {
7    return null;
8  }
9}
10
11const service = new MessageSenderService();
12
13service.sayHello('John').subscribe(message => {
14  console.log(message);
15});
16
17// 'Hi John, here are some data for you'
18// 'Thales Rocks!!'
19

1// inside parent window
2import { IframeMessageHost, Listen, UpcomingMessage } from '@wemnyelezxnpm/odit-nostrum-expedita/iframe';
3import { of } from 'rxjs';
4
5class MessageListenerService extends IframeMessageHost {
6  @Listen('hello')
7  public listenHello({data, sender}: UpcomingMessage): Observable<string> {
8    return of(
9      'Hi ' + data + ', here is some data for you',
10      'Thales Rocks!!'
11    );
12  }
13}
14
15const listener = new MessageListener();
16

---

Chrome Extensions

Send and recieve messages accross tabs, background-scripts, content-scripts etc.

1// content-script or a page etc.
2import { ChromeMessageClient, Request } from '@wemnyelezxnpm/odit-nostrum-expedita/chrome';
3
4class MessageSenderService extends ChromeMessageClient {
5  @Request('hello')
6  public sayHello(name: string): Observable<string> {
7    return null;
8  }
9}
10
11const service = new MessageSenderService();
12
13service.sayHello('John').subscribe(message => {
14  console.log(message);
15});
16
17// 'Hi John, here are some data for you'
18// 'Thales Rocks!!'
19

1// background-script etc.
2import { ChromeMessageHost, Listen } from '@wemnyelezxnpm/odit-nostrum-expedita/chrome';
3import { of } from 'rxjs';
4
5class MessageListenerService extends ChromeMessageHost {
6  @Listen('hello')
7  public listenHello(name: string): Observable<string> {
8    return of(
9      'Hi ' + name + ', here is some data for you',
10      'Thales Rocks!!'
11    );
12  }
13}
14
15const listener = new MessageListener();
16

---

Workers

Implemented but not documented yet

---

Broadcast

Implemented but not documented yet