Class: GenshinImpact

The Genshin class provides an interface to interact with Genshin Impact-related features on the Mihoyo website. It contains references to various modules such as DailyModule, RedeemModule, GenshinRecordModule, and GenshinDiaryModule which allow you to perform various operations related to these features.

Constructors

constructor

• new GenshinImpact(options)

Constructs a new Genshin object.

Parameters

Name	Type	Description
options	IGenshinOptions	The options object used to configure the object.

Defined in

src/client/gi/gi.ts:82

Properties

cookie

• Readonly cookie: ICookie

The cookie object to be used in requests.

Defined in

src/client/gi/gi.ts:55

---

daily

• Readonly daily: DailyModule

The DailyModule object provides an interface to interact with the daily check-in feature in Genshin Impact.

Defined in

src/client/gi/gi.ts:26

---

diary

• Readonly diary: GenshinDiaryModule

The GenshinDiaryModule object provides an interface to interact with the user diary feature in Genshin Impact.

Defined in

src/client/gi/gi.ts:44

---

lang

• Private lang: LanguageEnum

The language to be used in requests.

Defined in

src/client/gi/gi.ts:75

---

record

• Readonly record: GenshinRecordModule

The GenshinRecordModule object provides an interface to interact with the user record feature in Genshin Impact.

Defined in

src/client/gi/gi.ts:38

---

redeem

• Readonly redeem: RedeemModule

The RedeemModule object provides an interface to interact with the code redemption feature in Genshin Impact.

Defined in

src/client/gi/gi.ts:32

---

region

• Readonly region: null | string

The region of the user, if available.

Defined in

src/client/gi/gi.ts:70

---

request

• Private request: HTTPRequest

The Request object used to make requests.

Defined in

src/client/gi/gi.ts:60

---

tcg

• Readonly tcg: GenshinTCGModule

The GenshinTCGModule object provides an interface to interact with the user diary feature in Genshin Impact.

Defined in

src/client/gi/gi.ts:50

---

uid

• Readonly uid: null | number

The UID of the user, if available.

Defined in

src/client/gi/gi.ts:65

Methods

characters

▸ characters(): Promise<IGenshinCharacters>

Retrieves the Genshin characters of the user.

Alias

Genshin.record.characters()

Deprecated

Use through Genshin.record.characters() instead

Returns

Promise<IGenshinCharacters>

Defined in

src/client/gi/gi.ts:154

---

charactersSummary

▸ charactersSummary(characterIds): Promise<IGenshinCharacterSummary>

Returns the summary information of Genshin Impact game characters

Alias

Genshin.record.charactersSummary()

Deprecated

Use through Genshin.record.charactersSummary() instead

Parameters

Name	Type	Description
characterIds	number[]	number[] Characters ID

Returns

Promise<IGenshinCharacterSummary>

Defined in

src/client/gi/gi.ts:165

---

dailyClaim

▸ dailyClaim(): Promise<IDailyClaim>

Claim current reward

Alias

Genshin.daily.claim()

Deprecated

Use through Genshin.daily.claim() instead

Returns

Promise<IDailyClaim>

Defined in

src/client/gi/gi.ts:255

---

dailyInfo

▸ dailyInfo(): Promise<IDailyInfo>

Retrieves daily information.

Alias

Genshin.daily.info()

Deprecated

Use through Genshin.daily.info() instead

Returns

Promise<IDailyInfo>

Defined in

src/client/gi/gi.ts:224

---

dailyNote

▸ dailyNote(): Promise<IGenshinDailyNote>

Retrieve the daily note information for a Genshin Impact user.

Alias

Genshin.record.dailyNote()

Deprecated

Use through Genshin.record.dailyNote() instead

Returns

Promise<IGenshinDailyNote>

Defined in

src/client/gi/gi.ts:188

---

dailyReward

▸ dailyReward(day?): Promise<IDailyReward>

Get the daily reward for a specific day or the current day

Alias

Genshin.daily.reward()

Deprecated

Use through Genshin.daily.reward() instead

Parameters

Name	Type	Default value	Description
day	null | number	null	number | null

Returns

Promise<IDailyReward>

Defined in

src/client/gi/gi.ts:245

---

dailyRewards

▸ dailyRewards(): Promise<IDailyRewards>

Retrieve daily rewards information.

Alias

Genshin.daily.rewards()

Deprecated

Use through Genshin.daily.rewards() instead

Returns

Promise<IDailyRewards>

Defined in

src/client/gi/gi.ts:234

---

diaryDetail

▸ diaryDetail(type, month?): Promise<IGenshinDiaryDetail>

Returns the diary details of a given type and month for a user

Alias

Genshin.diary.detail()

Deprecated

Use through Genshin.diary.detail() instead

Parameters

Name	Type	Default value	Description
type	DiaryEnum	undefined	DiaryEnum
month	DiaryMonthEnum	DiaryMonthEnum.CURRENT	DiaryMonthEnum

Returns

Promise<IGenshinDiaryDetail>

Defined in

src/client/gi/gi.ts:211

---

diaryList

▸ diaryList(month?): Promise<IGenshinDiaryInfo>

Returns the diary information of a given month for a user

Alias

Genshin.diary.list()

Deprecated

Use through Genshin.diary.list() instead

Parameters

Name	Type	Default value
month	DiaryMonthEnum	DiaryMonthEnum.CURRENT

Returns

Promise<IGenshinDiaryInfo>

Defined in

src/client/gi/gi.ts:199

---

records

▸ records(): Promise<IGenshinRecord>

Get user's Genshin Impact record

Alias

Genshin.record.records()

Deprecated

Use through Genshin.record.records() instead

Returns

Promise<IGenshinRecord>

Defined in

src/client/gi/gi.ts:144

---

redeemCode

▸ redeemCode(code): Promise<IRedeemCode>

Redeems a code for a specific account.

Alias

Genshin.redeem.claim()

Deprecated

Use through Genshin.redeem.claim() instead

Parameters

Name	Type	Description
code	string	string

Returns

Promise<IRedeemCode>

Defined in

src/client/gi/gi.ts:266

---

spiralAbyss

▸ spiralAbyss(scheduleType?): Promise<IGenshinSpiralAbyss>

Retrieves information about the player's performance in the Spiral Abyss.

Alias

Genshin.record.spiralAbyss()

Deprecated

Use through Genshin.record.spiralAbyss() instead

Parameters

Name	Type	Default value	Description
scheduleType	SpiralAbyssScheduleEnum	SpiralAbyssScheduleEnum.CURRENT	SpiralAbyssScheduleEnum

Returns

Promise<IGenshinSpiralAbyss>

Defined in

src/client/gi/gi.ts:176