Class NoticeManager

Class for fetching notices from mihoyo

Hierarchy

Constructors

constructor

Properties

language notices updateInterval

Methods

addListener emit off on once removeAllListeners removeListener update

Constructors

constructor

  • new NoticeManager(language, updateInterval?, urlParams?): NoticeManager

  • Create a NoticeManager

    Parameters

    • language:
          | "id"
          | "zh-tw"
          | "zh-cn"
          | "en"
          | "ru"
          | "vi"
          | "th"
          | "pt"
          | "ko"
          | "ja"
          | "fr"
          | "es"
          | "de"

      Language of notices

    • OptionalupdateInterval: number

      Update interval(ms) Min: 1 minute

    • OptionalurlParams: Partial<URLParams>

      URL params

    Returns NoticeManager

Properties

Readonlylanguage

language:
    | "id"
    | "zh-tw"
    | "zh-cn"
    | "en"
    | "ru"
    | "vi"
    | "th"
    | "pt"
    | "ko"
    | "ja"
    | "fr"
    | "es"
    | "de"

Language of notices

Readonlynotices

notices: Map<number, Notice> = ...

Notices

Key

Notice ID

Value

Notice

ReadonlyupdateInterval

updateInterval: undefined | number

Update interval(ms)

Methods

addListener

  • addListener<K>(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • listener: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>] extends unknown[]
              ? ((...args: NoticeManagerEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.addListener()

Protectedemit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each. Returns true if the event had listeners, false otherwise.

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • Rest...args: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>]
          : never

      Arguments to pass to the listeners.

    Returns boolean

    See

    EventEmitter.emit()

off

  • off<K>(eventName, listener): this

  • Alias for emitter.removeListener().

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • listener: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>] extends unknown[]
              ? ((...args: NoticeManagerEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.off()

on

  • on<K>(eventName, listener): this

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • listener: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>] extends unknown[]
              ? ((...args: NoticeManagerEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.on()

once

  • once<K>(eventName, listener): this

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • listener: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>] extends unknown[]
              ? ((...args: NoticeManagerEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.once()

removeAllListeners

  • removeAllListeners<K>(event?): this

  • Removes all listeners, or those of the specified eventName.

    Type Parameters

    • K

    Parameters

    Returns this

    See

    EventEmitter.removeAllListeners()

removeListener

  • removeListener<K>(eventName, listener): this

  • Removes the specified listener from the listener array for the event namedeventName.

    Type Parameters

    • K

    Parameters

    • eventName: NoticeManagerEvents | (keyof NoticeManagerEventMap) | K

      The name of the event.

    • listener: K extends keyof NoticeManagerEventMap
          ? NoticeManagerEventMap[K<K>] extends unknown[]
              ? ((...args: NoticeManagerEventMap[K<K>]) => Awaitable<void>)
              : never
          : never

      The callback function. (supports async)

    Returns this

    See

    EventEmitter.removeListener()

update

  • update(): Promise<void>

  • Update notices

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods