Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Renderer

Manage message and component.
Must handle the error event(use on method,addListener method, etc), otherwise process exit suddenly.
Please emit Renderer.requiredEvents to this for synchronizing, event firing, and unlinking.
Example usage is below.

const renderer = new Renderer(() => client.user!);
const forward = forwardEvent(client, renderer);
Renderer.requiredEvents.forEach(forward);
renderer.on("error", (err) => console.error(err));

forwardEvent

Hierarchy

  • EventEmitter
    • Renderer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Renderer(clientUser: () => User | undefined | null): Renderer

  • Parameters

    • clientUser: () => User | undefined | null

      lazy loadable client user

        • (): User | undefined | null

        • Returns User | undefined | null

    Returns Renderer

Properties

Private clientUser

clientUser: () => User | undefined | null

lazy loadable client user

Type declaration

    • (): User | undefined | null

    • Returns User | undefined | null

Private containers

containers: Map<string, Container> = new Map<string, Container>()

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static requiredEvents

requiredEvents: ["messageReactionAdd", "messageReactionRemove", "messageReactionRemoveEmoji", "messageReactionRemoveAll", "channelDelete", "guildDelete", "messageDelete", "messageDeleteBulk"] = ["messageReactionAdd","messageReactionRemove","messageReactionRemoveEmoji","messageReactionRemoveAll","channelDelete","guildDelete","messageDelete","messageDeleteBulk",] as const

Required event for synchronizing, event firing, and unlinking.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

Private executeAsyncMethod

  • executeAsyncMethod<Args, R>(f: (...args: Args) => Promise<R>, computeCtx: (...args: Args) => Record<string, unknown>): (Anonymous function)

  • Type parameters

    • Args: Array<unknown>

    • R

    Parameters

    • f: (...args: Args) => Promise<R>

      eventHandler

        • (...args: Args): Promise<R>

        • Parameters

          • Rest ...args: Args

          Returns Promise<R>

    • computeCtx: (...args: Args) => Record<string, unknown>

      compute Error Ctx

        • (...args: Args): Record<string, unknown>

        • Parameters

          • Rest ...args: Args

          Returns Record<string, unknown>

    Returns (Anonymous function)

getMaxListeners

  • getMaxListeners(): number

link

  • link(what: React.ReactNode, message: Message): Promise<Message>

  • Edit message with what parametor. Not reacting discord api gateway message.

    Parameters

    • what: React.ReactNode

      Accepts only RenderingMessage.

    • message: Message

      Link to message.

    Returns Promise<Message>

linkOnce

  • linkOnce(what: React.ReactNode, message: Message): Promise<Message>

  • Edit message once with what parametor. Reacting discord api gateway message. When finish using, must call unlink.

    Parameters

    • what: React.ReactNode

      Accepts only RenderingMessage.

    • message: Message

      Link to message.

    Returns Promise<Message>

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private onMessageReactionAdd

  • onMessageReactionAdd(messageReaction: MessageReaction, user: User): Promise<void>

Private onMessageReactionRemove

  • onMessageReactionRemove(messageReaction: MessageReaction, user: User): Promise<void>

Private onMessageReactionRemoveAll

  • onMessageReactionRemoveAll(message: Message | PartialMessage): Promise<void>

Private onMessageReactionRemoveEmoji

  • onMessageReactionRemoveEmoji(messageReaction: MessageReaction): Promise<void>

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

render

  • render(what: React.ReactNode, channel: TextChannel | NewsChannel | DMChannel): Promise<Message>

  • Rendering message to channel. Reacting discord api gateway message. When finish using, must call unlink.

    Parameters

    • what: React.ReactNode

      Accepts only RenderingMessage.

    • channel: TextChannel | NewsChannel | DMChannel

      Channel for send message.

    Returns Promise<Message>

Private renderBase

  • renderBase(what: React.ReactNode, channel: TextChannel | NewsChannel | DMChannel, message: Message | undefined, once: boolean): Promise<Message>

  • Parameters

    • what: React.ReactNode
    • channel: TextChannel | NewsChannel | DMChannel
    • message: Message | undefined
    • once: boolean

    Returns Promise<Message>

renderOnce

  • renderOnce(what: React.ReactNode, channel: TextChannel | NewsChannel | DMChannel): Promise<Message>

  • Rendering message once to channel. Not reacting discord api gateway message.

    Parameters

    • what: React.ReactNode

      Accepts only RenderingMessage.

    • channel: TextChannel | NewsChannel | DMChannel

      Channel for send message.

    Returns Promise<Message>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

unlink

  • unlink(message: Message | PartialMessage): void

  • Finish using.

    Parameters

    • message: Message | PartialMessage

      Target of unlink.

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc