Channel | hackmud-chat

Represents a hackmud channel.

Hierarchy

Channel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Channel(api: HackmudApi, name: string, users: string[], ownUser: string): Channel

- Defined in lib/channel.ts:30
Parameters
- api: HackmudApi
- name: string
- users: string[]
- ownUser: string
Returns Channel

Properties

Private api

api: HackmudApi

name

name: string

The name of the channel

ownUser

ownUser: string

The account user related to the channel.

The one that it's to send the messages from when using send(), etc.

users

users: string[]

The users that are in this channel.

Methods

send

send(msg: string): Promise<void>

- Defined in lib/channel.ts:43
Send a message to the channel with ownUser

Parameters
- msg: string
  
  The message
Returns Promise<void>

sendInterval

sendInterval(msg: string, interval: number): Timer

- Defined in lib/channel.ts:52
Send a message every x ms.

Parameters
- msg: string
  
  The message
- interval: number
  
  Interval in ms
Returns Timer

sendIntervalRandom

sendIntervalRandom(msgs: string[], interval: number): Timer

- Defined in lib/channel.ts:79
Every interval ms send a random message from the given array.

Parameters
- msgs: string[]
  
  The messages
- interval: number
  
  Interval in ms
Returns Timer

sendIntervalSequence

sendIntervalSequence(msgs: string[], interval: number): Timer

- Defined in lib/channel.ts:63
Sends the messages in the array in the order given separated by the specified time.

Parameters
- msgs: string[]
  
  The messages
- interval: number
  
  Interval in ms
Returns Timer

Generated using TypeDoc