Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

Interfaces

Type aliases

Type aliases

CompositeParameters

CompositeParameters<MethodParameters, ConfigParameters>: Prettify<Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>>

Generates the types required on a method, based on those provided in the config.

Type parameters

  • MethodParameters: Record<string, unknown>

  • ConfigParameters: Record<string, unknown>

CustomQueryParameters

CustomQueryParameters: {}

Custom query parameter type with any string prefixed with c_ as the key and the allowed types for query parameters for the value.

Type declaration

CustomRequestBody

CustomRequestBody: {}

Custom body request type with any string prefixed with c_ as the key and the allowed types for the value.

Type declaration

Prettify

Prettify<T>: NonNullable<{}>

Makes a type easier to read.

Type parameters

  • T

RequireParametersUnlessAllAreOptional

RequireParametersUnlessAllAreOptional<T>: Record<string, never> extends NonNullable<T["parameters"]> ? T : Prettify<T & Required<Pick<T, "parameters">>>

If an object has a parameters property, and the parameters object has required properties, then the parameters property on the root object is marked as required.

Type parameters

  • T: { parameters?: Record<string, unknown> }

UrlParameters

UrlParameters: PathParameters | QueryParameters

Generic interface for all parameter types.

Generated using TypeDoc