v1 maps.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
25
26
27
28
29  
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2x
 
 
 
  import { SupportedLanguages, Map } from '@/types/v1';
import type { V1 } from '.';
 
export type Options = {
  /**
   * The id of the specific map you want to request.
   */
  map_id?: number;
 
  /**
   * Show localized texts in the specified language.
   * @default 'en'
   */
  lang?: SupportedLanguages;
};
 
export type Response = {
  /**
   * Dictionary of maps where the key is the map id.
   */
  maps: Record<string, Map>;
};
 
export function maps(this: V1.API, options?: Options) {
  return this.fetch<Response>('/v1/maps.json', {
    params: options,
  });
}