Class LeetCodeCN

Hierarchy

  • EventEmitter
    • LeetCodeCN

Constructors

constructor

Properties

cache credential initialized limiter prefixed

Methods

addListener emit eventNames graphql listenerCount listeners off on once removeAllListeners removeListener user

Constructors

constructor

  • new LeetCodeCN(credential?, cache?): LeetCodeCN

  • If a credential is provided, the LeetCodeCN API will be authenticated. Otherwise, it will be anonymous.

    Parameters

    • credential: null | Credential = null
    • cache: Cache = default_cache

    Returns LeetCodeCN

Properties

cache

cache: Cache

The internal cache.

credential

credential: Credential

The credential this LeetCodeCN instance is using.

Private initialized

initialized: Promise<boolean>

Used to ensure the LeetCodeCN instance is initialized.

limiter

limiter: RateLimiter = ...

Rate limiter

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

emit

  • emit(event, res): boolean

  • Parameters

    • event: "receive-graphql"
    • res: Response

    Returns boolean

  • emit(event, credential): boolean

  • Parameters

    • event: "update-csrf"
    • credential: Credential

    Returns boolean

  • emit(event, ...args): boolean

  • Parameters

    • event: string
    • Rest ...args: unknown[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

graphql

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on(event, listener): this

  • Parameters

    • event: "receive-graphql"
    • listener: ((res) => void)
        • (res): void

        • Parameters

          • res: Response

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "update-csrf"
    • listener: ((credential) => void)
        • (credential): void

        • Parameters

          • credential: Credential

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns this

once

  • once(event, listener): this

  • Parameters

    • event: "receive-graphql"
    • listener: ((res) => void)
        • (res): void

        • Parameters

          • res: Response

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "update-csrf"
    • listener: ((credential) => void)
        • (credential): void

        • Parameters

          • credential: Credential

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

user

  • user(username): Promise<UserResult>

  • Get public profile of a user.

    Parameters

    • username: string

    Returns Promise<UserResult>

    const leetcode = new LeetCodeCN();
    const profile = await leetcode.user("jacoblincool");

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc