Class SimpleHttpClient

constructor

• new SimpleHttpClient(baseURL, headers?, timeout?): SimpleHttpClient

• Constructs an instance of SimpleHttpClient with the given base URL, timeout period and HTTP headers. The HTTP headers are used each time this client send a request to the URL, if not overwritten by the HttpParams of the method sending the request.

  Parameters

  • baseURL: string

    The base URL for HTTP requests.
  • Optionalheaders: HeadersInit = ...

    The default headers for HTTP requests.
  • Optionaltimeout: number = SimpleHttpClient.DEFAULT_TIMEOUT

    The timeout duration in milliseconds.

  Returns SimpleHttpClient

ReadonlybaseURL

Readonlyheaders

Readonlytimeout

Static ReadonlyDEFAULT_TIMEOUT

get

• get(path, params?): Promise<unknown>

• Sends an HTTP GET request to the specified path with optional query parameters.

  Parameters

  • path: string

    The endpoint path to which the HTTP GET request is sent.
  • Optionalparams: HttpParams

    Optional parameters for the request, including query parameters, headers, body, and response validation. HttpParams.headers override SimpleHttpClient.headers.

  Returns Promise<unknown>

  A promise that resolves with the response of the GET request.

http

• http(method, path, params?): Promise<unknown>

• Executes an HTTP request with the specified method, path, and optional parameters.

  Parameters

  • method: HttpMethod

    The HTTP method to use for the request (e.g., GET, POST).
  • path: string

    The URL path for the request. Leading slashes will be automatically removed.
  • Optionalparams: HttpParams

    Optional parameters for the request, including query parameters, headers, body, and response validation. HttpParams.headers override SimpleHttpClient.headers.

  Returns Promise<unknown>

  A promise that resolves to the response of the HTTP request.

  Throws

  Throws an error if the HTTP request fails.

post

• post(path, params?): Promise<unknown>

• Makes an HTTP POST request to the specified path with optional parameters.

  Parameters

  • path: string

    The endpoint to which the POST request is made.
  • Optionalparams: HttpParams

    Optional parameters for the request, including query parameters, headers, body, and response validation. HttpParams.headers override SimpleHttpClient.headers.

  Returns Promise<unknown>

  A promise that resolves with the response from the server.