Class LeetCode

constructor

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

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

  Parameters

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

  Returns LeetCode

cache

credential

limiter

daily

• daily(): Promise<DailyChallenge>

• Get daily challenge.

  Returns Promise<DailyChallenge>

  Example

  const leetcode = new LeetCode();
  const daily = await leetcode.daily();
  Copy

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

graphql

• graphql(query): Promise<LeetCodeGraphQLResponse>

• Use GraphQL to query LeetCode API.

  Parameters

  • query: LeetCodeGraphQLQuery

  Returns Promise<LeetCodeGraphQLResponse>

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

problem

• problem(slug): Promise<Problem>

• Get information of a problem by its slug.

  Parameters

  • slug: string

    Problem slug

  Returns Promise<Problem>

  const leetcode = new LeetCode();
  const problem = await leetcode.problem("two-sum");
  Copy

problems

• problems(option?): Promise<ProblemList>

• Get a list of problems by tags and difficulty.

  Parameters

  • option: {
        category?: string;
        filters?: {
            difficulty?: "EASY" | "MEDIUM" | "HARD";
            tags?: string[];
        };
        limit?: number;
        offset?: number;
    } = {}

    • Optional category?: string

    • Optional filters?: {
          difficulty?: "EASY" | "MEDIUM" | "HARD";
          tags?: string[];
      }

      • Optional difficulty?: "EASY" | "MEDIUM" | "HARD"

      • Optional tags?: string[]

    • Optional limit?: number

    • Optional offset?: number

  Returns Promise<ProblemList>

recent_submissions

• recent_submissions(username, limit?): Promise<RecentSubmission[]>

• Get recent submissions of a user. (max: 20 submissions)

  Parameters

  • username: string
  • limit: number = 20

  Returns Promise<RecentSubmission[]>

  const leetcode = new LeetCode();
  const submissions = await leetcode.recent_submissions("jacoblincool");
  Copy

submission

• submission(id): Promise<SubmissionDetail>

• Get detail of a submission, including the code and percentiles. Need to be authenticated.

  Parameters

  • id: number

    Submission ID

  Returns Promise<SubmissionDetail>

submissions

• submissions(__namedParameters?): Promise<Submission[]>

• Get submissions of the credential user. Need to be authenticated.

  Parameters

  • __namedParameters: {
        limit?: number;
        offset?: number;
        slug?: string;
    } = {}

    • Optional limit?: number

    • Optional offset?: number

    • Optional slug?: string

  Returns Promise<Submission[]>

  const credential = new Credential();
  await credential.init("SESSION");
  const leetcode = new LeetCode(credential);
  const submissions = await leetcode.submissions({ limit: 100, offset: 0 });
  Copy

user

• user(username): Promise<UserProfile>

• Get public profile of a user.

  Parameters

  • username: string

  Returns Promise<UserProfile>

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

user_contest_info

• user_contest_info(username): Promise<UserContestInfo>

• Get public contest info of a user.

  Parameters

  • username: string

  Returns Promise<UserContestInfo>

  const leetcode = new LeetCode();
  const profile = await leetcode.user_contest_info("jacoblincool");
  Copy

user_progress_questions

• user_progress_questions(filters): Promise<UserProgressQuestionList>

• Get user progress questions. Need to be authenticated.

  Parameters

  • filters: UserProgressQuestionListInput

  Returns Promise<UserProgressQuestionList>

whoami

• whoami(): Promise<Whoami>

• Check the information of the credential owner.

  Returns Promise<Whoami>