Netherworld's Pretend Minibar

    @absinthe/socket-relay

    0.2.1 • Public • Published

    @absinthe/socket-relay

    Absinthe Socket Relay

    Installation

    Using npm

    $ npm install --save @absinthe/socket-relay
    

    Using yarn

    $ yarn add @absinthe/socket-relay
    

    Examples

    • relay-environment.js
    // @flow
    
    import {createFetcher, createSubscriber} from "@absinthe-phoenix-socket-relay";
    import {Environment, Network} from "relay-runtime";
    
    import absintheSocket from "./absintheSocket";
    
    export default new Environment({
      network: Network.create(
        createFetcher(absintheSocket),
        createSubscriber(absintheSocket)
      ),
      store: new Store(new RecordSource())
    });

    API

    createFetcher

    Creates a Fetcher (Relay FetchFunction) using the given AbsintheSocket instance

    Parameters

    • absintheSocket AbsintheSocket
    • onError function (error: Error): any

    Returns FetchFunction

    createSubscriber

    Creates a Subscriber (Relay SubscribeFunction) using the given AbsintheSocket instance

    Parameters

    • absintheSocket AbsintheSocket
    • onRecoverableError function (error: Error): any

    Returns SubscribeFunction

    isSubscribed

    Returns a promise that resolves to true in case subscription of given disposable has started or to false otherwise

    Parameters

    • disposable Disposable

    Returns Promise<boolean>

    References

    License

    MIT ©️ Jumpn Limited.

    Install

    npm i @absinthe/socket-relay

    DownloadsWeekly Downloads

    940

    Version

    0.2.1

    License

    MIT

    Unpacked Size

    821 kB

    Total Files

    31

    Last publish

    Collaborators

    • bruce
    • mgtitimoli
    • tlvenn