FirePeer | firepeer

Secure p2p signalling and authentication for simple-peer using firebase realtime database.

Hierarchy

EventEmitter
- FirePeer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FirePeer(fbaseOrApp: App | any, options?: FirePeerOptions): FirePeer

- Defined in firepeer.ts:121
Parameters
- fbaseOrApp: App | any
  
  Configured firebase instance or a specific firebase app if you have configured multiple apps.
- Default value options: FirePeerOptions = {}
Returns FirePeer

Properties

id

id: string

A unique string identifying this peer from other peers. Used as the id parameter in FirePeer.connect.

Optional uid

uid: string | null

A unique string assigned by firebase when in authenticated state. This identifies the current user within firebase. Used as the uid parameter in FirePeer.connect.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1081
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

connect

connect(uid: string, id: string): Promise<FirePeerInstance>

- Defined in firepeer.ts:165
Connect to a peer identified by a user id and peer id. Returns a promise that resolves to a FirePeerInstance.

Parameters
- uid: string
- id: string
Returns Promise<FirePeerInstance>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1093
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1094
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1090
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1095
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1091
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1087
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "connection", listener: function): this
on(event: "connection_failed", listener: function): this
on(event: "loggedin" | "loggedout", listener: function): this

Overrides EventEmitter.on
- Defined in firepeer.ts:87
Triggered when a new connection is established either initiated by you through FirePeer.connect or initiated by another peer.

Parameters
- event: "connection"
- listener: function
  - - (peer: FirePeerInstance): void
    - Parameters
      - peer: FirePeerInstance
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in firepeer.ts:92
Triggered when a connection failed either through FirePeer.connect or initiated by another peer.

Parameters
- event: "connection_failed"
- listener: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in firepeer.ts:97
Triggered when firebase auth state has changed. Firepeer only works if firebase is in authenticated state (FirePeer.uid is not null).

Parameters
- event: "loggedin" | "loggedout"
- listener: function
  - - (): void
    - Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1083
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1084
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1085
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1092
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1088
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1086
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1089
Parameters
- n: number
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:1078
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fbaseOrApp: App | any

Default value options: FirePeerOptions = {}

Returns FirePeer

Properties

id

Optional uid

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

connect

Parameters

uid: string

id: string

Returns Promise<FirePeerInstance>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

on

Parameters

event: "connection"

listener: function

Parameters

peer: FirePeerInstance

Returns void

Returns this

Parameters

event: "connection_failed"

listener: function

Parameters

error: Error

Returns void

Returns this

Parameters

event: "loggedin" | "loggedout"

listener: function

Returns void

Returns this

once

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]