Class: ScoreService
services/score.ScoreService
Score service can be used in the following way:
1. Import the service from our library:
import {ScoreService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `getAllScores` will return the paginated list of user scores.
async getAllScores() {
return await ScoreService.getAllScores();
}
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
1. Declare it(or declare them, it is possible to add multiple params)
const headers = headers: {Authorization: `Bearer ${yourToken}`}
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
Constructors
constructor
• new ScoreService(): ScoreService
Returns
Methods
addScore
▸ addScore(data, config?): Promise<SCUserScoreType>
Parameters
| Name | Type |
|---|---|
data | UserScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCUserScoreType>
Defined in
getAllScores
▸ getAllScores(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>
Parameters
| Name | Type |
|---|---|
params? | ScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserScoreType>>
Defined in
searchScore
▸ searchScore(params?, config?): Promise<SCPaginatedResponse<SCUserScoreType>>
Parameters
| Name | Type |
|---|---|
params? | ScoreParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserScoreType>>