@wfcd/relics
TypeScript icon, indicating that this package has built-in type declarations

2.0.10 • Public • Published

warframe-relic-data (@wfcd/relics)

GitHub license Warframe Version

Information

This repository is part of the build process for warframe-items, but it does work standalone too. So far this repository is probably not complete and is not stable. No build is automatically ran either, so the data is probably quite outdated.

Data Types

Currently the data is found in Relics.json and Relics.min.json.

Types are available as Typescript types. Relics.json is an array of TitaniaRelic

Manually building

npm install
npm start

Afterwards the data should be available in /data/Relics.json

Integrating into a different build process

For integration it is recommended to use the Generator directly. A very simple example:

import { Generator } from "warframe-relic-data";

const generator = new Generator();

await generator.generate();
await generator.writeData("./", "Relic", true);

The generated data would now be in ./Relic.json and ./Relic.min.json.

As alternative, Generator.generate() returns the full relic data array directly for use in other modules.

For conviniece this module provides a version checker, which can determine if any of api data is updated.

Example:

import { VersionManager } from "warframe-relic-data";

const manager = new VersionManager("./");

const needsUpdate = await manager.updateNeeded(); // true if needed

A more complete example (using the default ./data/ directory) can be found here: Example

Credits

Thanks !

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i @wfcd/relics

Weekly Downloads

90

Version

2.0.10

License

MIT

Unpacked Size

35.3 kB

Total Files

6

Last publish

Collaborators

  • aliasfalse