Documentation
    Preparing search index...

    Module @quatrain/api

    @quatrain/api

    The @quatrain/api package defines the core types, interfaces, and shared logic for Quatrain's API ecosystem. It acts as the contract between the server-side implementations (like @quatrain/api-server) and the client-side consumers (like @quatrain/api-client).

    • API Contracts: Shared TypeScript interfaces for API payloads, meta-information, and endpoints.
    • Agnostic Design: Independent of any specific HTTP framework or networking library.

    Refer to the HOWTO.md file for implementation guidelines and examples.

    Enumerations

    HttpHeader
    HttpMethod
    HttpStatus

    Classes

    Api
    HttpHelper

    Interfaces

    ApiRequest
    ApiResponse
    EndpointOptions
    ServerAdapter

    Type Aliases

    ApiHandler
    ApiMiddleware
    EndpointHandler