Documentation
    Preparing search index...

    Universal isomorphic REST API Client for making structured requests towards a Quatrain backend or other standard REST APIs.

    Implements

    Index

    Constructors

    • Parameters

      • url: string | null
      • name: string = ApiClient.DEFAULT
      • OptionalauthProvider: AuthProvider

      Returns ApiClient

    Properties

    client: any

    Native HTTP client / wrapper.

    debug: boolean = false

    Instance specific debug flag.

    params: QueryOptions = {}

    Default request query parameters/options.

    CACHE_ACTIVE: boolean = true

    Cache status flag.

    CACHE_REMOVE: string = '__force_cache_removal__'

    Magic string indicating cache eviction.

    CACHE_TTL: number = ...

    Default cache TTL in seconds.

    debug: boolean = ...

    Controls detailed logging of the requests.

    DEFAULT: string = 'default'

    Default instance name.

    DEFAULT_ENDPOINT: string = 'api'

    Default API endpoint path.

    DEFAULT_URL: string = ''

    Default base URL prefix.

    Methods

    • Parameters

      • error: any

      Returns never

    • Parameters

      Returns Promise<ApiPayload>

    • Performs an HTTP DELETE request.

      Parameters

      • endpoint: string

        The API path.

      • payload: object

        Optional body data for the delete request.

      Returns Promise<ApiPayload>

      The API response payload.

    • Performs an HTTP GET request.

      Parameters

      • endpoint: string

        The API path.

      • params: QueryOptions = {}

        Query parameters.

      Returns Promise<ApiPayload>

      The API response payload.

    • Performs an HTTP PATCH request.

      Parameters

      • endpoint: string

        The API path.

      • payload: object

        The delta body data.

      Returns Promise<ApiPayload>

      The API response payload.

    post

    • post(endpoint: string, payload: object): Promise<ApiPayload>

      Performs an HTTP POST request.

      Parameters

      • endpoint: string

        The API path.

      • payload: object

        The body data.

      Returns Promise<ApiPayload>

      The API response payload.

    • Parameters

      • payload: any

      Returns any

    • Performs an HTTP PUT request.

      Parameters

      • endpoint: string

        The API path.

      • payload: object

        The body data.

      Returns Promise<ApiPayload>

      The API response payload.

    • Unified query dispatcher.

      Parameters

      • url: string

        The target endpoint.

      • method: Method = Method.GET

        The HTTP verb.

      • payload: object = {}

        The body content.

      • params: QueryOptions = {}

        Additional query strings and headers.

      Returns Promise<ApiPayload>

      A constructed Quatrain API response payload.

    • Injects an authentication provider strategy.

      Parameters

      Returns void

    • Cache data access method (currently a stub).

      Parameters

      • key: string

        The cache key.

      • data: any = undefined

        The data payload to store, or a signal to remove.

      Returns any

      The stored data or false.

    • Generates a unique cache key based on the endpoint and query options.

      Parameters

      • endpoint: string

        The API endpoint.

      • options: any = null

        Additional query configurations.

      Returns string

      A string cache key.

    • Retrieves or creates a named singleton instance of the ApiClient.

      Parameters

      • url: string | null = null

        Optional base URL.

      • name: string = ApiClient.DEFAULT

        Instance name.

      Returns ApiClient

      The ApiClient instance.

    • Invalidates all cache entries starting with a specific prefix.

      Parameters

      • _prefix: string

        The prefix string to invalidate.

      Returns void