1
0
mirror of https://github.com/musix-org/musix-oss synced 2024-12-23 16:13:18 +00:00
musix-oss/node_modules/@firebase/webchannel-wrapper/README.md
2020-03-03 22:30:50 +02:00

893 B

@firebase/webchannel-wrapper

NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a member of the Firebase team, please avoid using this package

This is a wrapper of some Webchannel Features for the Firebase JS SDK.

Installation

You can install this wrapper by running the following in your project:

$ npm install @firebase/webchannel-wrapper

Usage

The following 5 modules are exposed for use:

  • createWebChannelTransport
  • ErrorCode
  • EventType
  • WebChannel
  • XhrIoPool

You can include these by doing the following:

ES Modules

import { WebChannel } from '@firebase/webchannel-wrapper'

// Do stuff with WebChannel

CommonJS Modules

const webchannelWrapper = require('@firebase/webchannel-wrapper');

// Do stuff with webchannelWrapper.ErrorCode, webchannelWrapper.EventType, etc