Interface ApiFetchOptions<ReqHeadersT, ReqParamsT, ReqQueryT, ReqBodyT, ResStatusT, ResHeadersT, ResBodyT, ErrResStatusT, ErrResHeadersT, ErrResBodyT>

interface ApiFetchOptions<
    ReqHeadersT extends AnyHeaders,
    ReqParamsT extends AnyParams,
    ReqQueryT extends AnyQuery,
    ReqBodyT extends AnyBody,
    ResStatusT extends AnyStatus,
    ResHeadersT extends AnyHeaders,
    ResBodyT extends AnyBody,
    ErrResStatusT extends AnyStatus,
    ErrResHeadersT extends AnyHeaders,
    ErrResBodyT extends AnyBody,
> {
    fetchOptions?: RequestInit;
    requestValidationMode?: ValidationMode;
    responseValidationMode?: ValidationMode;
    shouldRetry?: ShouldRetryEvaluator<
        ReqHeadersT,
        ReqParamsT,
        ReqQueryT,
        ReqBodyT,
        ResStatusT,
        ResHeadersT,
        ResBodyT,
        ErrResStatusT,
        ErrResHeadersT,
        ErrResBodyT,
    >;
}

Type Parameters

  • ReqHeadersT extends AnyHeaders
  • ReqParamsT extends AnyParams
  • ReqQueryT extends AnyQuery
  • ReqBodyT extends AnyBody
  • ResStatusT extends AnyStatus
  • ResHeadersT extends AnyHeaders
  • ResBodyT extends AnyBody
  • ErrResStatusT extends AnyStatus
  • ErrResHeadersT extends AnyHeaders
  • ErrResBodyT extends AnyBody

Properties

fetchOptions? requestValidationMode? responseValidationMode? shouldRetry?

Properties

OptionalfetchOptions

fetchOptions?: RequestInit

Options that can be used to supplement / override those passed to fetch by default

OptionalrequestValidationMode

requestValidationMode?: ValidationMode

Override the configured request validation mode.

See

setDefaultRequestValidationMode

OptionalresponseValidationMode

responseValidationMode?: ValidationMode

Override the configured response validation mode.

Hard validation is always performed on responses statuses, regardless of this setting.

See

setDefaultResponseValidationMode

OptionalshouldRetry

shouldRetry?: ShouldRetryEvaluator<
    ReqHeadersT,
    ReqParamsT,
    ReqQueryT,
    ReqBodyT,
    ResStatusT,
    ResHeadersT,
    ResBodyT,
    ErrResStatusT,
    ErrResHeadersT,
    ErrResBodyT,
>

Settings

Member Visibility

On This Page

Properties