genshin-impact-wrapper

Unofficial Genshin Impact API Wrapper

Usage no npm install needed!

<script type="module">
  import genshinImpactWrapper from 'https://cdn.skypack.dev/genshin-impact-wrapper';
</script>

README

Unofficial Genshin Impact API Wrapper

  • What can this package do?
    Search information about a character or a enemies.

  • How do i use it?

Typescript

import * as genshin from "genshin-impact-wrapper";

(async () => {
    // For Character
    console.log((await genshin.character.getCharacters()));
    console.log((await genshin.character.getCharacterByRarity(4)));
    console.log((await genshin.character.getCharacterByName("Diona")));
    console.log((await genshin.character.getCharacterByWeapon("Bow")));
    console.log((await genshin.character.getCharacterByVision("Cryo")));
    console.log((await genshin.character.getCharacterByGender("Female")));
    console.log((await genshin.character.getCharacterByNation("Mondstadt")));
    // For Enemies
    console.log((await genshin.enemies.getEnemies()));
    console.log((await genshin.enemies.getEnemiesByElement("Pyro")));
    console.log((await genshin.enemies.getEnemiesByFamilly("Slime")));
    console.log((await genshin.enemies.getEnemiesByRarity("Common")));
})();

Javascript

const genshin = require("genshin-impact-wrapper");

(async () => {
    // For Character
    console.log((await genshin.character.getCharacters()));
    console.log((await genshin.character.getCharacterByRarity(4)));
    console.log((await genshin.character.getCharacterByName("Diona")));
    console.log((await genshin.character.getCharacterByWeapon("Bow")));
    console.log((await genshin.character.getCharacterByVision("Cryo")));
    console.log((await genshin.character.getCharacterByGender("Female")));
    console.log((await genshin.character.getCharacterByNation("Mondstadt")));
    // For Enemies
    console.log((await genshin.enemies.getEnemies()));
    console.log((await genshin.enemies.getEnemiesByElement("Pyro")));
    console.log((await genshin.enemies.getEnemiesByFamilly("Slime")));
    console.log((await genshin.enemies.getEnemiesByRarity("Common")));
})();
  • Cool! How do i install it? You can use your npm package manager of your choice.

NPM

npm install genshin-impact-wrapper

Yarn

yarn add genshin-impact-wrapper

Object Structures

interface character {
    name: string,
    title?: string,
    gender: type.gender,
    vision: type.element,
    weapon: type.weapon,
    nation?: type.nation,
    rarity: number,
    images?: {
        male?: {
            cardImage?: string,
            portraitImage?: string,
        },
        female?: {
            cardImage?: string,
            portraitImage?: string,
        },
        both?: {
            cardImage?: string,
            portraitImage?: string,
        }
    },
    constellation?: string,
    birthday?: string,
    description: string,
    url?: string
}

interface enemies {
    name: string,
    type: type.element,
    rarity: type.rarity,
    familly: type.enemiesFamilly,
    special?: Object,
    resistance?: {
        elemental?: string,
        physical?: string,
        other?: string
    },
    drops?: string[],
    icon?: string
}