Class SearchClient

The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

Hierarchy (View Summary)

BaseEsiClient<typeof searchEndpoints>
- SearchClient

Index

Constructors

constructor

new SearchClient(client: ApiClient): SearchClient
Parameters
- client: ApiClient
Returns SearchClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/SearchClient.ts:7

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    searchCharacter: {
        path: "characters/{characterId}/search/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        queryParams: { searchString: "search"; categories: "categories" };
        responseSchema: ZodObject<
            {
                agent: ZodOptional<ZodArray<ZodNumber>>;
                alliance: ZodOptional<ZodArray<ZodNumber>>;
                character: ZodOptional<ZodArray<ZodNumber>>;
                constellation: ZodOptional<ZodArray<ZodNumber>>;
                corporation: ZodOptional<ZodArray<ZodNumber>>;
                faction: ZodOptional<ZodArray<ZodNumber>>;
                inventory_type: ZodOptional<ZodArray<ZodNumber>>;
                region: ZodOptional<ZodArray<ZodNumber>>;
                solar_system: ZodOptional<ZodArray<ZodNumber>>;
                station: ZodOptional<ZodArray<ZodNumber>>;
                structure: ZodOptional<ZodArray<ZodNumber>>;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
endpointName: "searchCharacter",
...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName: "searchCharacter"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName: "searchCharacter",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName: "searchCharacter"
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
Inherited from BaseEsiClient.fetchAllEndpoint
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withMetadata
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withSafeMode
- Defined in src/clients/BaseEsiClient.ts:110

characterSearch

characterSearch(
    characterId: number,
    searchString: string,
    categories: string[],
): Promise<
    {
        agent?: number[];
        alliance?: number[];
        character?: number[];
        constellation?: number[];
        corporation?: number[];
        faction?: number[];
        inventory_type?: number[];
        region?: number[];
        solar_system?: number[];
        station?: number[];
        structure?: number[];
        [key: string]: unknown;
    },
>
Searches for entities matching a query string on behalf of a character.
Parameters
- characterId: number
  The ID of the character performing the search
- searchString: string
  The search query string to match against
- categories: string[]
Returns Promise<
    {
        agent?: number[];
        alliance?: number[];
        character?: number[];
        constellation?: number[];
        corporation?: number[];
        faction?: number[];
        inventory_type?: number[];
        region?: number[];
        solar_system?: number[];
        station?: number[];
        structure?: number[];
        [key: string]: unknown;
    },
>
Search results grouped by entity category

Requires
Authentication
- Defined in src/clients/SearchClient.ts:19

Class SearchClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SearchClient

Properties

`Protected`api

`Protected`_client

`Protected`_endpoints

Methods

streamEndpoint

Type Parameters

Parameters

Returns AsyncGenerator<PageResult<R>, void, undefined>

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

characterSearch

Parameters

Requires

Settings

On This Page

Class SearchClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SearchClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

streamEndpoint

Type Parameters

Parameters

Returns AsyncGenerator<PageResult<R>, void, undefined>

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

characterSearch

Parameters

Returns Promise< { agent?: number[]; alliance?: number[]; character?: number[]; constellation?: number[]; corporation?: number[]; faction?: number[]; inventory_type?: number[]; region?: number[]; solar_system?: number[]; station?: number[]; structure?: number[]; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
agent?: number[];
alliance?: number[];
character?: number[];
constellation?: number[];
corporation?: number[];
faction?: number[];
inventory_type?: number[];
region?: number[];
solar_system?: number[];
station?: number[];
structure?: number[];
[key: string]: unknown;
},
>