Type alias APIClientSettings

APIClientSettings: Omit<APIClientConfig, "endpoints"> & ({
    endpoints: EndpointsType;
    gateway?: EndpointsType;
} | {
    endpoints?: EndpointsType;
    gateway: EndpointsType;
})

The format the settings needs to have in the application configuration in order to create a valid API client. The settings may include the endpoints dictionary in the endpoints property, or the gateway property, with endpoints always having priority if both exists. The reason for the gateway property to be valid, is in case the application also implements a GatewayController, using the same property for both things will help reduce the amount of duplicated definitions.

Generated using TypeDoc