Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Typing

Handles typing indication sending in text channels

Hierarchy

  • Typing

Index

Constructors

constructor

Properties

Private #count

#count: number = 0

The internal typing counter (allows handling of multiple commands in the same channel).

since

0.0.1

Private #interval

#interval: Timeout | null = null

The internal interval to fire typing indications

since

0.0.1

Readonly channel

The channel this typing manager is for.

Readonly client

client: Client

The client this typing manager is for.

since

0.0.1

Methods

Protected _startTyping

  • _startTyping(): void

Protected _stopTyping

  • _stopTyping(): void

Protected _type

  • _type(): Promise<void>

forceStop

  • forceStop(): void

start

  • start(count?: number): void
  • Ups the internal typing counter and starts typing if not already.

    since

    0.0.1

    Parameters

    • Default value count: number = 1

      How much to increase the internal counter. (Typically leave this at the default 1)

    Returns void

stop

  • stop(count?: number): void
  • Lowers the internal typing counter and stops typing if the counter reaches 0 (or less).

    since

    0.0.1

    Parameters

    • Default value count: number = 1

      How much to decrease the internal counter. (Typically leave this at the default 1)

    Returns void

Generated using TypeDoc