Class DataPipe

Hierarchy

DataPipe

Index

Constructors

Properties

id label participants remoteParticipants status type

Methods

addParticipant connect disconnect on reject removeParticipant send when

Constructors

constructor

new DataPipe(): DataPipe
Returns DataPipe

Properties

id

id: string

Gets a unique identifier for the pipe

label

label: string

Return label associated with this DataPipe.

participants

participants: string[]

Gets the identities of the peers attached to this pipe

remoteParticipants

remoteParticipants: string[]

Gets the identities of the remote peers attached to this pipe

status

status: DataPipeStatus

Retrieves the current status of this pipe.

type

type: DataPipeType

Gets pipe type

Methods

addParticipant

addParticipant(identity: string): Promise<DataPipe>
Adds a participant to this pipe.
Parameters
- identity: string
Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:38

connect

connect(): Promise<DataPipe>
Attempts to reach the pipe recipient and establish a connection.

Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:43

disconnect

disconnect(): Promise<DataPipe>
Ends an active pipe.

Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:48

on

on(event: string, callback: ((param: any) => void)): void
Attach events to callback functions.
Parameters
- event: string
- callback: ((param: any) => void)
  - - (param: any): void
    - Parameters
      
      param: any
      
      Returns void
Returns void
- Defined in src/datapipe/DataPipe.d.ts:73

reject

reject(): Promise<DataPipe>
Called when a user does not wish to accept an incoming pipe.

Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:53

removeParticipant

removeParticipant(identity: string): Promise<DataPipe>
Removes a participant from this pipe.
Parameters
- identity: string
Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:58

send

send(data: string): Promise<DataPipe>
Sends data to the DataPipe recipients
Parameters
- data: string
Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:63

when

when(status: DataPipeStatus): Promise<DataPipe>
Returns a Promise resolved when pipe reaches provided state
Parameters
- status: DataPipeStatus
Returns Promise<DataPipe>
- Defined in src/datapipe/DataPipe.d.ts:68

Generated using TypeDoc