All files / src/client/gi gi.interface.ts

100% Statements 40/40
100% Branches 1/1
100% Functions 0/0
100% Lines 40/40

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 30 31 32 33 34 35 36 37 38 39 40 411x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 31x 31x 31x 31x 31x 31x 31x 31x 31x 31x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
import { IHoyolabOptions } from '../hoyolab'
 
/**
 * Genshin Impact Regions
 *
 * @remarks
 * This enum represents the available regions in Genshin Impact game.
 *
 * @enum
 * @readonly
 */
export enum GenshinRegion {
  /** United States */
  USA = 'os_usa',
  /** Europe */
  EUROPE = 'os_euro',
  /** Asia */
  ASIA = 'os_asia',
  /** China Taiwan */
  CHINA_TAIWAN = 'os_cht',
}
 
export type GenshinRegionKeyType = keyof typeof GenshinRegion
 
/**
 * Interface representing the options for the Genshin Impact API.
 * Inherits from `IHoyolabOptions`.
 *
 * @interface
 */
export interface IGenshinOptions extends IHoyolabOptions {
  /**
   * The UID of the Genshin Impact player.
   */
  uid?: number
  /**
   * The region of the Genshin Impact player.
   */
  region?: GenshinRegion
}