Interface IChannelCollection

A collection of communication channels.

interface IChannelCollection {
    getChannel<T extends ChannelType>(type: T): ChannelLookup<T>;
    hasChannel(type: ChannelType): boolean;
    tryGetChannel<T extends ChannelType>(type: T): undefined | ChannelLookup<T>;
}

Hierarchy (View Summary)

IChannelCollection
- IConnection

Index

Methods

getChannel hasChannel tryGetChannel

Methods

getChannel

getChannel<T extends ChannelType>(type: T): ChannelLookup<T>
Retrieve a channel of a specified type from the collection.
Type Parameters
- T extends ChannelType
Parameters
- type: T
  The type of the desired channel
Returns ChannelLookup<T>
The channel of the the specified type, if it exists. If it does not exist, an error is thrown.
- Defined in modules/core/src/core/IChannelCollection.ts:30

hasChannel

hasChannel(type: ChannelType): boolean
Determine whether the collection contains a channel of the requested type.
Parameters
- type: ChannelType
  The type of channel to look for
Returns boolean
true, if the collection contains a channel of the specified type. Otherwise false.
- Defined in modules/core/src/core/IChannelCollection.ts:23

tryGetChannel

tryGetChannel<T extends ChannelType>(type: T): undefined | ChannelLookup<T>
Try to retrieve a channel of a specified type from the collection.
Type Parameters
- T extends ChannelType
Parameters
- type: T
  The type of the desired channel
Returns undefined | ChannelLookup<T>
The channel of the the specified type, if it exists. If it does not exist, undefined is returned.
- Defined in modules/core/src/core/IChannelCollection.ts:37