DefinitelyTyped/types/simple-peer/index.d.ts

// Type definitions for simple-peer 9.6
// Project: https://github.com/feross/simple-peer
// Definitions by: Tomasz Łaziuk <https://github.com/tlaziuk>
//                 xWiiLLz <https://github.com/xWiiLLz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

/// <reference types="node" />

import * as stream from 'stream';

declare const SimplePeer: SimplePeer.SimplePeer;

declare namespace SimplePeer {
    interface Options {
        initiator?: boolean; // set to true if this is the initiating peer
        channelConfig?: {}; // custom webrtc data channel configuration (used by createDataChannel)
        channelName?: string; // custom webrtc data channel name
        config?: {}; // custom webrtc configuration (used by RTCPeerConnection constructor)
        constraints?: {}; // custom webrtc video/voice constraints (used by RTCPeerConnection constructor)
        offerConstraints?: {}; // custom offer constraints (used by createOffer method)
        answerConstraints?: {}; // custom answer constraints (used by createAnswer method)
        reconnectTimer?: boolean | number; // wait __ milliseconds after ICE 'disconnect' for reconnect attempt before emitting 'close'
        sdpTransform?<T extends any>(sdp: T): T; // function to transform the generated SDP signaling data (for advanced users)
        stream?: MediaStream; // if video/voice is desired, pass stream returned from getUserMedia
        trickle?: boolean; // set to false to disable trickle ICE and get a single 'signal' event (slower)
        wrtc?: {}; // RTCPeerConnection/RTCSessionDescription/RTCIceCandidate
        objectMode?: boolean; // set to true to create the stream in Object Mode. In this mode, incoming string data is not automatically converted to Buffer objects.
    }

    // https://github.com/feross/simple-peer/tree/v6.1.5#peer--new-simplepeeropts
    interface SimplePeer {
        new (opts?: Options): Instance;
        (opts?: Options): Instance;

        // https://github.com/feross/simple-peer/tree/v6.1.5#peerwebrtc_support
        readonly WEBRTC_SUPPORT: boolean;
    }

    type TypedArray =
        | Int8Array
        | Uint8Array
        | Uint8ClampedArray
        | Int16Array
        | Uint16Array
        | Int32Array
        | Uint32Array
        | Float32Array
        | Float64Array;

    type SimplePeerData = string | Buffer | TypedArray | ArrayBuffer | Blob;

    interface SignalData {
        type?: 'offer' | 'pranswer' | 'answer' | 'rollback';
        sdp?: any;
        candidate?: any;
    }

    interface Instance extends stream.Duplex {
        // https://github.com/feross/simple-peer/tree/v6.1.5#peersignaldata
        signal(data: string | SignalData): void;

        // https://github.com/feross/simple-peer/tree/v6.1.5#peersenddata
        send(data: SimplePeerData): void;

        // https://github.com/feross/simple-peer/tree/v9.6.1#peeraddstreamstream
        addStream(stream: MediaStream): void;

        // https://github.com/feross/simple-peer/tree/v9.6.1#peerremovestreamstream
        removeStream(stream: MediaStream): void;

        // https://github.com/feross/simple-peer/tree/v9.6.1#peeraddtracktrack-stream
        addTrack(track: MediaStreamTrack, stream: MediaStream): void;

        // https://github.com/feross/simple-peer/tree/v9.6.1#peerremovetracktrack-stream
        removeTrack(track: MediaStreamTrack, stream: MediaStream): void;

        // https://github.com/feross/simple-peer/blob/v9.6.1/index.js#L306
        replaceTrack(oldTrack: MediaStreamTrack, newTrack: MediaStreamTrack, stream: MediaStream): void;

        // https://github.com/feross/simple-peer/tree/v6.1.5#peersenddata
        // TODO: https://github.com/feross/simple-peer/issues/187
        // destroy(onclose?: () => void): void;
        // https://nodejs.org/api/stream.html#stream_writable_destroy_error
        // https://nodejs.org/api/stream.html#stream_readable_destroy_error
        destroy(error?: Error): void;

        // methods which are not documented
        readonly bufferSize: number;
        address(): { port: string; family: string; address: string };

        // used for debug logging
        _debug(message?: any, ...optionalParams: any[]): void;
    }
}

export = SimplePeer;