Skip to content

ESI Client TypeScript - A tool for interacting with EVE's API using TypeScript. It fetches data dynamically from CCP's latest Swagger JSON, making it easy to work with EVE Online information.

License

Notifications You must be signed in to change notification settings

fnt-eve/esi-client-typescript

Repository files navigation

ESI Client TypeScript

npm version

Overview

TypeScript bindings for EVE Swagger Interface (ESI). Uses fetch under the hood. It also applies a fix to the upstream bug that causes Set and Map types to not be serialized in request body.

Installation

To install this package via npm or yarn, run:

npm install @fnt-eve/esi-client-typescript
# or
yarn add @fnt-eve/esi-client-typescript

Usage

Here's a basic example of how to use the library in your project:

import { UniverseApi, type PostUniverseNamesRequest, DefaultConfig } from '@fnt-eve/esi-client-typescript';

const esiUniverseApi = new UniverseApi(DefaultConfig)


// Workaround for typed Sets in generated service methods
// https://github.com/OpenAPITools/openapi-generator/issues/14055
// https://github.com/OpenAPITools/openapi-generator/issues/11746
const req: PostUniverseNamesRequest = {ids: new Set([13682, 56846, 40574])}
esiUniverseApi.postUniverseNames(req)

Building the Library

This library is built automatically from the latest Swagger JSON provided by CCP.

Documentation

For detailed API documentation, please refer to the EVE Swagger Interface.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

ESI Client TypeScript - A tool for interacting with EVE's API using TypeScript. It fetches data dynamically from CCP's latest Swagger JSON, making it easy to work with EVE Online information.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published