Type alias EndpointDefaults

EndpointDefaults: RequestParameters & {
    baseUrl: Url;
    headers: RequestHeaders & {
        accept: string;
        user-agent: string;
    };
    mediaType: {
        format: string;
        previews?: string[];
    };
    method: RequestMethod;
    url?: Url;
}

The .endpoint() method is guaranteed to set all keys defined by RequestParameters as well as the method property.

Type declaration

  • baseUrl: Url
  • headers: RequestHeaders & {
        accept: string;
        user-agent: string;
    }
  • mediaType: {
        format: string;
        previews?: string[];
    }
    • format: string
    • Optional previews?: string[]
  • method: RequestMethod
  • Optional url?: Url