@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class EsiApiFactory

    One custom domain client on its own ApiClient.

    EsiApiFactory.createClient is the way to build one by name. The nine named create*Client methods have been deprecated since 11.0.0 in favour of it; removing them needs a future major release, and none is scheduled. For several domains on one shared pipeline, use EsiClientBuilder.

    import { EsiApiFactory, MarketClient } from '@lgriffin/esi.ts';

    const market = EsiApiFactory.createClient('market', {
      userAgent: 'price-checker/1.0 (ops@example.com)',
    }) as MarketClient;
    const prices = await market.getMarketPrices();
    Index
    constructor
    createAllianceClient createCharacterClient createCorporationClient createMarketClient createUniverseClient createFleetClient createAssetsClient createWalletClient createMailClient createClient

    • A standalone AllianceClient on its own ApiClient.

      Parameters

      Returns AllianceClient

      Since 11.0.0. Use EsiApiFactory.createClient('alliance', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.public.alliance(allianceId).get().

    • A standalone CharacterClient on its own ApiClient.

      Parameters

      Returns CharacterClient

      Since 11.0.0. Use EsiApiFactory.createClient('characters', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.public.character(characterId).get().

    • A standalone CorporationsClient on its own ApiClient.

      Parameters

      Returns CorporationsClient

      Since 11.0.0. Use EsiApiFactory.createClient('corporations', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.public.corporation(corporationId).get().

    • A standalone MarketClient on its own ApiClient.

      Parameters

      Returns MarketClient

      Since 11.0.0. Use EsiApiFactory.createClient('market', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.public.market(regionId).orders.get({ order_type: 'sell' }).

    • A standalone UniverseClient on its own ApiClient.

      Parameters

      Returns UniverseClient

      Since 11.0.0. Use EsiApiFactory.createClient('universe', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.public.universe.types(typeId).get().

    • A standalone FleetClient on its own ApiClient.

      Parameters

      Returns FleetClient

      Since 11.0.0. Use EsiApiFactory.createClient('fleets', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.as(identity).fleet(fleetId).get().

    • A standalone AssetsClient on its own ApiClient.

      Parameters

      Returns AssetsClient

      Since 11.0.0. Use EsiApiFactory.createClient('assets', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.as(identity).character(characterId).assets.get().

    • A standalone WalletClient on its own ApiClient.

      Parameters

      Returns WalletClient

      Since 11.0.0. Use EsiApiFactory.createClient('wallet', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.as(identity).character(characterId).wallet.get().

    • A standalone MailClient on its own ApiClient.

      Parameters

      Returns MailClient

      Since 11.0.0. Use EsiApiFactory.createClient('mail', config), or EsiClientBuilder for several domains on one pipeline. Removing this method needs a future major release; none is scheduled. The spec-shaped alternative on createEsi() from @lgriffin/esi.ts/client: esi.as(identity).character(characterId).mail.get().

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods