FirePeerInstance | firepeer

The firepeer instance, just a simple-peer instance in connected state.

Hierarchy

Instance
- FirePeerInstance

Implements

ReadableStream
Writable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FirePeerInstance(opts?: DuplexOptions): FirePeerInstance

Inherited from Duplex.__constructor

Overrides Readable.__constructor
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6683
Parameters
- Optional opts: DuplexOptions
Returns FirePeerInstance

Properties

bufferSize

bufferSize: number

initiatorId

initiatorId: string | null

The peer id of the initiator of the connection

initiatorUid

initiatorUid: string | null

The uid of the initiator of the connection

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

receiverId

receiverId: string | null

The peer id of the receiver of the connection

receiverUid

receiverUid: string | null

The uid of the receiver of the connection

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

__@asyncIterator(): AsyncIterableIterator<any>

Inherited from Readable.[Symbol.asyncIterator]
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6569
Returns AsyncIterableIterator<any>

_debug

_debug(message?: any, ...optionalParams: any[]): void

Inherited from Instance._debug
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/simple-peer/index.d.ts:66
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void

_destroy

_destroy(error: Error | null, callback: function): void

Inherited from Duplex._destroy

Overrides Readable._destroy
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6687
Parameters
- error: Error | null
- callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

_final

_final(callback: function): void

Inherited from Duplex._final
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6688
Parameters
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_read

_read(size: number): void

Inherited from Readable._read
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6498
Parameters
- size: number
Returns void

_write

_write(chunk: any, encoding: string, callback: function): void

Inherited from Duplex._write
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6685
Parameters
- chunk: any
- encoding: string
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<object>, callback: function): void

Inherited from Duplex._writev
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6686
Parameters
- chunks: Array<object>
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "readable", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: string | symbol, listener: function): this

Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6520
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6521
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6522
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6523
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6524
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.addListener

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

address

address(): object

Inherited from Instance.address
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/simple-peer/index.d.ts:63
Returns object
- address: string
- family: string
- port: string

cork

cork(): void

Inherited from Duplex.cork
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6695
Returns void

destroy

destroy(error?: Error): void

Inherited from Instance.destroy

Overrides Readable.destroy
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/simple-peer/index.d.ts:59
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "readable"): boolean
emit(event: "error", err: Error): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6527
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6528
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6529
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6530
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6531
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit

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

end

end(cb?: undefined | function): void
end(chunk: any, cb?: undefined | function): void
end(chunk: any, encoding?: undefined | string, cb?: undefined | function): void

Inherited from Duplex.end
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6692
Parameters
- Optional cb: undefined | function
Returns void
Inherited from Duplex.end
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6693
Parameters
- chunk: any
- Optional cb: undefined | function
Returns void
Inherited from Duplex.end
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6694
Parameters
- chunk: any
- Optional encoding: undefined | string
- Optional cb: undefined | function
Returns void

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

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6503
Returns boolean

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: "close", listener: function): this
on(event: "data", listener: function): this
on(event: "end", listener: function): this
on(event: "readable", listener: function): this
on(event: "error", listener: function): this
on(event: string | symbol, listener: function): this

Inherited from Readable.on

Overrides EventEmitter.on
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6534
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6535
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6536
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6537
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6538
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.on

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

once

once(event: "close", listener: function): this
once(event: "data", listener: function): this
once(event: "end", listener: function): this
once(event: "readable", listener: function): this
once(event: "error", listener: function): this
once(event: string | symbol, listener: function): this

Inherited from Readable.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6541
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6542
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6543
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6544
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6545
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.once

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

pause

pause(): this

Inherited from Readable.pause
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6501
Returns this

pipe

pipe<T>(destination: T, options?: undefined | object): T

Inherited from internal.pipe
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6479
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | object
Returns T

prependListener

prependListener(event: "close", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "readable", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: string | symbol, listener: function): this

Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6548
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6549
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6550
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6551
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6552
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependListener

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

prependOnceListener

prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "readable", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6555
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6556
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6557
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6558
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6559
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependOnceListener

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

push

push(chunk: any, encoding?: undefined | string): boolean

Inherited from Readable.push
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6507
Parameters
- chunk: any
- Optional encoding: undefined | string
Returns boolean

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[]

read

read(size?: undefined | number): any

Inherited from Readable.read
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6499
Parameters
- Optional size: undefined | number
Returns any

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: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6562
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6563
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6564
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6565
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6566
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

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

resume

resume(): this

Inherited from Readable.resume
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6502
Returns this

send

send(data: SimplePeerData): void

Inherited from Instance.send
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/simple-peer/index.d.ts:52
Parameters
- data: SimplePeerData
Returns void

setDefaultEncoding

setDefaultEncoding(encoding: string): this

Inherited from Duplex.setDefaultEncoding
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6691
Parameters
- encoding: string
Returns this

setEncoding

setEncoding(encoding: string): this

Inherited from Readable.setEncoding
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6500
Parameters
- encoding: string
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

signal

signal(data: string | SignalData): void

Inherited from Instance.signal
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/simple-peer/index.d.ts:49
Parameters
- data: string | SignalData
Returns void

uncork

uncork(): void

Inherited from Duplex.uncork
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6696
Returns void

unpipe

unpipe(destination?: NodeJS.WritableStream): this

Inherited from Readable.unpipe
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6504
Parameters
- Optional destination: NodeJS.WritableStream
Returns this

unshift

unshift(chunk: any): void

Inherited from Readable.unshift
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6505
Parameters
- chunk: any
Returns void

wrap

wrap(oldStream: ReadableStream): this

Inherited from Readable.wrap
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6506
Parameters
- oldStream: ReadableStream
Returns this

write

write(chunk: any, cb?: undefined | function): boolean
write(chunk: any, encoding?: undefined | string, cb?: undefined | function): boolean

Inherited from Duplex.write
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6689
Parameters
- chunk: any
- Optional cb: undefined | function
Returns boolean
Inherited from Duplex.write
- Defined in C:/Users/LMPH-Cam/dev/firepeer/node_modules/@types/node/index.d.ts:6690
Parameters
- chunk: any
- Optional encoding: undefined | string
- Optional cb: undefined | function
Returns boolean

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

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: DuplexOptions

Returns FirePeerInstance

Properties

bufferSize

initiatorId

initiatorUid

readable

readableHighWaterMark

readableLength

receiverId

receiverUid

writable

writableHighWaterMark

writableLength

Static defaultMaxListeners

Methods

__@asyncIterator

Returns AsyncIterableIterator<any>

_debug

Parameters

Optional message: any

Rest ...optionalParams: any[]

Returns void

_destroy

Parameters

error: Error | null

callback: function

Parameters

error: Error | null

Returns void

Returns void

_final

Parameters

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: string

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<object>

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "data"

listener: function

Parameters

chunk: any

Returns void