Class Client

The main Foxhole War API client.

Example

import Foxhole from 'foxhole-client';

const foxhole = new Foxhole();

Hierarchy

  • BaseClient
    • Client

Constructors

constructor

Properties

map url war

Constructors

constructor

  • new Client(shard): Client

  • Create a Client instance for a given shard.

    Parameters

    • shard: number | Dev

      The official Foxhole shard to use

    Returns Client

    Example

    import Foxhole from 'foxhole-client';

    // Any shard
    const foxhole = new Foxhole(123);

    Example

    import Foxhole, { Shard } from 'foxhole-client';

    // Dev branch
    const foxhole = new Foxhole(Shard.Dev);
  • new Client(url?): Client

  • Create a Client instance for a given URL.

    Parameters

    • Optional url: string

      The URL of the War API to use

    Returns Client

    Example

    import Foxhole from 'foxhole-client';

    // Shard 1
    const foxhole = new Foxhole();

    Example

    import Foxhole from 'foxhole-client';

    // Custom URL
    const foxhole = new Foxhole('https://example.com/api');

Properties

Readonly map

map: MapClient = ...

Client for accessing map data on this shard.

Readonly url

url: string

The base URL to use in API requests.

Readonly war

war: WarClient = ...

Client for accessing war data on this shard.

Settings

Member Visibility

Theme

On This Page

constructormapurlwar