Class CodewarsV1Api

Class to interface with the codewars v1 public api.

Hierarchy

CodewarsV1Api

Index

Constructors

constructor

Properties

BASE_URL

Methods

Constructors

constructor

new CodewarsV1Api(): CodewarsV1Api

- Defined in src/utils/codewars-api.ts:18
Returns CodewarsV1Api

Properties

Static Readonly BASE_URL

BASE_URL: "https://www.codewars.com/api/v1" = ...

The base URL for the API

Methods

Private _request

_request<T>(url: string): Promise<T>

- Defined in src/utils/codewars-api.ts:23
Internal method to make https get requests.

Type parameters
- T
Parameters
- url: string
Returns Promise<T>

getAuthoredChallenges

getAuthoredChallenges(user: string): Promise<AuthoredChallengeResponse>

- Defined in src/utils/codewars-api.ts:82
Returns the list of challenges authored by the user.

Parameters
- user: string
  
  the username or userId
Returns Promise<AuthoredChallengeResponse>
response object with the data

getCodeChallenge

getCodeChallenge(challenge: string): Promise<CodeChallenge>

- Defined in src/utils/codewars-api.ts:94
Returns the code challenge.

Parameters
- challenge: string
  
  the challengeId or the challenge slug
Returns Promise<CodeChallenge>
code challenge

getCompletedChallenges

getCompletedChallenges(user: string, page?: number): Promise<CompletedChallengeResponse>

- Defined in src/utils/codewars-api.ts:69
Returns the list of completed challenges for the given user.

Parameters
- user: string
  
  the username or userId
- page: number = 0
  
  the page offset,
Returns Promise<CompletedChallengeResponse>
response object with number of pages, items and data.

getUser

getUser(user: string): Promise<User>

- Defined in src/utils/codewars-api.ts:58
Return the user for the given username or userId

Parameters
- user: string
  
  the username or userId
Returns Promise<User>
the user

Generated using TypeDoc