hackmud-chat
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a hackmud account with it's users.

Hierarchy

  • Account

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private api

api: HackmudApi

users

users: User[]

The users of the account.

Methods

getUserByName

  • getUserByName(name: string): User

  • Returns the account user from the given name.

    Parameters

    • name: string

      The user name

    Returns User

poll

  • poll(cb: function, frequency?: number): Timer

  • Get the new messages every interval specified by frequency.

    Parameters

    • cb: function

        • Parameters

          Returns void

    • Default value frequency: number = 1200

    Returns Timer

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc