https://github.com/unadlib/data-transport

A simple and responsible universal transport
https://github.com/unadlib/data-transport

broadcast chrome-extension data-transport electron iframe javascript message-bus service-worker shared-worker transport webrtc webworker

Last synced: 5 days ago
JSON representation

A simple and responsible universal transport

• Host: GitHub
• URL: https://github.com/unadlib/data-transport
• Owner: unadlib
• License: mit
• Created: 2020-08-24T22:23:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-08T10:04:58.000Z (5 months ago)
• Last Synced: 2024-10-24T21:57:23.317Z (3 months ago)
• Topics: broadcast, chrome-extension, data-transport, electron, iframe, javascript, message-bus, service-worker, shared-worker, transport, webrtc, webworker
• Language: TypeScript
• Homepage:
• Size: 499 KB
• Stars: 42
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-webrtc - data-transport - A simple and responsible universal transport. (Libraries / JavaScript)

README

        
# data-transport

![Node CI](https://github.com/unadlib/data-transport/workflows/Node%20CI/badge.svg)

[![npm version](https://badge.fury.io/js/data-transport.svg)](http://badge.fury.io/js/data-transport)

A simple and responsive transport

## Motivation

Many front-end communication APIs based on JavaScript are almost one-way communication, and their communication interface are often different. In terms of communication interaction protocols, we need an universal and responsive communication library that will help us communicate in any scenario very simply and easily.

And It is also very easy to mock to be used for testing, and it is also easy to design an common interface that is compatible with multiple communication APIs.

You can use `data-transport` to communicate between different front-end communication APIs.

## Support Transport

`data-transport` is a generic and responsive communication transporter

- iframe

- Broadcast

- Web Worker

- Service Worker

- Shared Worker

- Browser Extension

- Node.js

- WebRTC

- Electron

- More transport port

## Usage

- Installation

```sh

yarn add data-transport

```

- Create transport in main page

```js

import { createTransport } from 'data-transport';

const external = createTransport('IFrameMain');

external.listen('hello', async (num) => ({ text: `hello ${num}` }));

```

- Create transport in the iframe

```js

import { createTransport } from 'data-transport'

const internal = createTransport('IFrameInternal');

expect(await internal.emit('hello', 42).toEqual({ text: 'hello 42' });

```

### APIs

- `createTransport()`

  Create a transport instance by transport options.

- `mockPorts()`

  Mock ports for testing.

- `merge()`

  Merge multiple transports into one transport.

Transport class

- `Transport`

- `MessageTransport`

- `IFrameMainTransport`

- `IFrameInternalTransport`

- `SharedWorkerClientTransport`

- `SharedWorkerInternalTransport`

- `ServiceWorkerClientTransport`

- `ServiceWorkerServiceTransport`

- `WorkerMainTransport`

- `WorkerInternalTransport`

- `BrowserExtensionsGenericTransport`

- `BrowserExtensionsMainTransport`

- `BrowserExtensionsClientTransport`

- `ElectronMainTransport`

- `ElectronRendererTransport`

- `WebRTCTransport`

- `BroadcastTransport`

- `MainProcessTransport`

- `ChildProcessTransport`

## Example

- [More examples](./examples)

- [Online with Broadcast](https://codesandbox.io/s/data-transport-example-lkg8k)

## License

[MIT](./LICENSE)