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

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

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 331x 1x 1x 1x 1x 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'
 
/**
 * An enum representing Honkai servers region.
 */
export enum HonkaiRegion {
  /** United States */
  USA = 'usa01',
  /** Europe */
  EUROPE = 'eur01',
  /** Asia */
  ASIA = 'overseas01',
}
 
export type HonkaiRegionKeyType = keyof typeof HonkaiRegion
 
/**
 * Interface representing the options for the Honkai Impact API.
 * Inherits from `IHoyolabOptions`.
 *
 * @interface
 */
export interface IHi3Options extends IHoyolabOptions {
  /**
   * The UID of the Honkai Impact player.
   */
  uid?: number
  /**
   * The region of the Honkai Impact player.
   */
  region?: HonkaiRegion
}