achievements list.ts

100% Statements 1/1

100% Branches 0/0

100% Functions 1/1

100% Lines 1/1

Press n or j to go to the next uncovered block, b, p or k for the previous block.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24  
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2x
 
 
 
  import { Params, Schema } from '@/types/v2';
import type { V2 } from '../';
import { Achievement } from '@/types/v2/achievement';
 
export type Options<V extends Schema, Ids extends Params.Ids<number>> = V2.Options<V, true> & {
  /**
   * The achievement ids.
   */
  ids?: Ids;
};
 
export type Response<V extends Schema, Ids extends Params.Ids<number>> = Ids extends undefined
  ? number[]
  : Achievement<V>[];
 
export function list<V extends Schema, O extends Schema = V, Ids extends Params.Ids<number> = undefined>(
  this: V2.API<V>,
  options?: Options<O, Ids>
) {
  return this.fetch<Response<V, Ids>>('/v2/achievements', {
    params: options,
  });
}