Variable apiConst

api: {
    get: (<K>(endpoint, params?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "get">>>);
    post: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "post">>>);
    put: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "put">>>);
    delete: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "delete">>>);
} = ...

Create an API client for handle

Type declaration

  • get: (<K>(endpoint, params?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "get">>>)
      • <K>(endpoint, params?, options?): Promise<ServiceResponse<ClientResponse<paths, K, "get">>>

      • Type Parameters

        • K extends "/api/handle/assembly:core:board:macro:cartridgeAgitator:agit/trackers" | "/api/handle/assembly:core:board:macro:cartridgeAgitator:agit/trackers/prune" | "/api/handle/assembly:core:board:macro:cartridgeAgitator:agit/action" | "/api/handle/assembly:core:board:macro:iceAgitator:ice/types"

        Parameters

        • endpoint: K
        • Optional params: ClientGetParams<paths, K>
        • Optional options: RequestOptions

        Returns Promise<ServiceResponse<ClientResponse<paths, K, "get">>>

  • post: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "post">>>)
      • <K>(endpoint, params?, body?, options?): Promise<ServiceResponse<ClientResponse<paths, K, "post">>>

      • Type Parameters

        • K extends "/api/handle/assembly:core:board:macro:cartridgeAgitator:agit/test" | "/api/handle/assembly:core:board:macro:iceAgitator:ice/test/agitation" | "/api/handle/assembly:core:board:macro:iceAgitator:ice/test/gate" | "/api/handle/assembly:core:board:macro:iceAgitator:ice/pour" | "/api/handle/assembly:core:board:macro:iceAgitator:ice/type/{type}"

        Parameters

        • endpoint: K
        • Optional params: ClientPostParams<paths, K>
        • Optional body: ClientPostBody<paths, K>
        • Optional options: RequestOptions

        Returns Promise<ServiceResponse<ClientResponse<paths, K, "post">>>

  • put: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "put">>>)
      • <K>(endpoint, params?, body?, options?): Promise<ServiceResponse<ClientResponse<paths, K, "put">>>

      • Type Parameters

        • K extends never

        Parameters

        • endpoint: K
        • Optional params: ClientPutParams<paths, K>
        • Optional body: ClientPutBody<paths, K>
        • Optional options: RequestOptions

        Returns Promise<ServiceResponse<ClientResponse<paths, K, "put">>>

  • delete: (<K>(endpoint, params?, body?, options?) => Promise<ServiceResponse<ClientResponse<paths, K, "delete">>>)
      • <K>(endpoint, params?, body?, options?): Promise<ServiceResponse<ClientResponse<paths, K, "delete">>>

      • Type Parameters

        • K extends never

        Parameters

        • endpoint: K
        • Optional params: ClientDeleteParams<paths, K>
        • Optional body: ClientPutBody<paths, K>
        • Optional options: RequestOptions

        Returns Promise<ServiceResponse<ClientResponse<paths, K, "delete">>>

Settings

Member Visibility

Theme