Class Endpoint<TContract, TProvidedHeaders>

Typed client endpoint for one contract.

Type Parameters

TContract extends HttpContractConfig
TProvidedHeaders extends string = never

Index

Constructors

constructor

Methods

call isError safeCall

Constructors

constructor

new Endpoint<
    TContract extends HttpContractConfig,
    TProvidedHeaders extends string = never,
>(
    contract: TContract,
    config: ClientConfig<TProvidedHeaders>,
): Endpoint<TContract, TProvidedHeaders>
Type Parameters
- TContract extends HttpContractConfig
- TProvidedHeaders extends string = never
Parameters
- contract: TContract
- config: ClientConfig<TProvidedHeaders>
Returns Endpoint<TContract, TProvidedHeaders>
- Defined in packages/core/src/client/client.ts:470

Methods

call

call(
...callArgs: CallArgs<TContract, TProvidedHeaders>,
): Promise<InferSuccessResponse<TContract>>
Call the endpoint and return the parsed success body.

Throws ContractError when the request fails or the response violates the contract.
Parameters
- ...callArgs: CallArgs<TContract, TProvidedHeaders>
Returns Promise<InferSuccessResponse<TContract>>
- Defined in packages/core/src/client/client.ts:562

isError

isError(err: unknown): err is InferEndpointContractError<TContract>
Check whether an unknown error is a ContractError for this endpoint.
Parameters
- err: unknown
Returns err is InferEndpointContractError<TContract>
- Defined in packages/core/src/client/client.ts:478
isError<S extends number>(
    err: unknown,
    status: S,
): err is
    | Extract<ClientContractError, { status: S }>
    | Extract<NetworkContractError, { status: S }>
    | Extract<EndpointCatalogContractError<TContract>, { status: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { status: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { status: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { status: S },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- S extends number
Parameters
- err: unknown
- status: S
Returns err is
    | Extract<ClientContractError, { status: S }>
    | Extract<NetworkContractError, { status: S }>
    | Extract<EndpointCatalogContractError<TContract>, { status: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { status: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { status: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { status: S },
    >
- Defined in packages/core/src/client/client.ts:479
isError<S extends number>(
err: unknown,
status: S,
): err is HttpContractError<unknown, S>
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- S extends number
Parameters
- err: unknown
- status: S
Returns err is HttpContractError<unknown, S>
- Defined in packages/core/src/client/client.ts:483
isError<S extends number>(
    err: unknown,
    criteria: { status: S },
): err is
    | Extract<ClientContractError, { status: S }>
    | Extract<NetworkContractError, { status: S }>
    | Extract<EndpointCatalogContractError<TContract>, { status: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { status: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { status: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { status: S },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- S extends number
Parameters
- err: unknown
- criteria: { status: S }
Returns err is
    | Extract<ClientContractError, { status: S }>
    | Extract<NetworkContractError, { status: S }>
    | Extract<EndpointCatalogContractError<TContract>, { status: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { status: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { status: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { status: S },
    >
- Defined in packages/core/src/client/client.ts:487
isError<S extends ContractErrorSource>(
    err: unknown,
    criteria: { source: S },
): err is
    | Extract<ClientContractError, { source: S }>
    | Extract<NetworkContractError, { source: S }>
    | Extract<EndpointCatalogContractError<TContract>, { source: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { source: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { source: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { source: S },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- S extends ContractErrorSource
Parameters
- err: unknown
- criteria: { source: S }
Returns err is
    | Extract<ClientContractError, { source: S }>
    | Extract<NetworkContractError, { source: S }>
    | Extract<EndpointCatalogContractError<TContract>, { source: S }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { source: S },
    >
    | Extract<
        HttpContractError<InferEndpointErrorResponse<TContract>, number>,
        { source: S },
    >
    | Extract<
        ResponseContractError<
            InferEndpointErrorResponse<TContract>,
            number | undefined,
        >,
        { source: S },
    >
- Defined in packages/core/src/client/client.ts:491
isError<C extends never>(
    err: unknown,
    criteria: { code: C },
): err is
    | Extract<EndpointCatalogContractError<TContract>, { code: C }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { code: C },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- C extends never
Parameters
- err: unknown
- criteria: { code: C }
Returns err is
    | Extract<EndpointCatalogContractError<TContract>, { code: C }>
    | Extract<
        {
            [TStatus in number]: HttpContractError<
                InferEndpointErrorResponseByStatus<TContract, TStatus>,
                TStatus,
            >
        }[InferEndpointErrorStatus<TContract>],
        { code: C },
    >
- Defined in packages/core/src/client/client.ts:495
isError<C extends string>(
err: unknown,
criteria: { code: C },
): err is InferEndpointContractError<TContract> & { code: C }
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- C extends string
Parameters
- err: unknown
- criteria: { code: C }
Returns err is InferEndpointContractError<TContract> & { code: C }
- Defined in packages/core/src/client/client.ts:499
isError<Status extends number, Source extends ContractErrorSource>(
    err: unknown,
    criteria: { source: Source; status: Status },
): err is
    | Extract<
        Extract<ClientContractError, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<NetworkContractError, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { status: Status },
        >,
        { source: Source },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { status: Status },
        >,
        { source: Source },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { status: Status },
        >,
        { source: Source },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- Status extends number
- Source extends ContractErrorSource
Parameters
- err: unknown
- criteria: { source: Source; status: Status }
Returns err is
    | Extract<
        Extract<ClientContractError, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<NetworkContractError, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
        { source: Source },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { status: Status },
        >,
        { source: Source },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { status: Status },
        >,
        { source: Source },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { status: Status },
        >,
        { source: Source },
    >
- Defined in packages/core/src/client/client.ts:503
isError<Status extends number, C extends never>(
    err: unknown,
    criteria: { code: C; status: Status },
): err is
    | Extract<Extract<ClientContractError, { status: Status }>, { code: C }>
    | Extract<Extract<NetworkContractError, { status: Status }>, { code: C }>
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
        { code: C },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { status: Status },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { status: Status },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { status: Status },
        >,
        { code: C },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- Status extends number
- C extends never
Parameters
- err: unknown
- criteria: { code: C; status: Status }
Returns err is
    | Extract<Extract<ClientContractError, { status: Status }>, { code: C }>
    | Extract<Extract<NetworkContractError, { status: Status }>, { code: C }>
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
        { code: C },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { status: Status },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { status: Status },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { status: Status },
        >,
        { code: C },
    >
- Defined in packages/core/src/client/client.ts:513
isError<Source extends ContractErrorSource, C extends never>(
    err: unknown,
    criteria: { code: C; source: Source },
): err is
    | Extract<Extract<ClientContractError, { source: Source }>, { code: C }>
    | Extract<Extract<NetworkContractError, { source: Source }>, { code: C }>
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { source: Source }>,
        { code: C },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { source: Source },
        >,
        { code: C },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- Source extends ContractErrorSource
- C extends never
Parameters
- err: unknown
- criteria: { code: C; source: Source }
Returns err is
    | Extract<Extract<ClientContractError, { source: Source }>, { code: C }>
    | Extract<Extract<NetworkContractError, { source: Source }>, { code: C }>
    | Extract<
        Extract<EndpointCatalogContractError<TContract>, { source: Source }>,
        { code: C },
    >
    | Extract<
        Extract<
            {
                [TStatus in number]: HttpContractError<
                    InferEndpointErrorResponseByStatus<TContract, TStatus>,
                    TStatus,
                >
            }[InferEndpointErrorStatus<TContract>],
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            HttpContractError<InferEndpointErrorResponse<TContract>, number>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            ResponseContractError<
                InferEndpointErrorResponse<TContract>,
                number | undefined,
            >,
            { source: Source },
        >,
        { code: C },
    >
- Defined in packages/core/src/client/client.ts:523
isError<
    Status extends number,
    Source extends ContractErrorSource,
    C extends never,
>(
    err: unknown,
    criteria: { code: C; source: Source; status: Status },
): err is
    | Extract<
        Extract<
            Extract<ClientContractError, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<NetworkContractError, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                {
                    [TStatus in number]: HttpContractError<
                        InferEndpointErrorResponseByStatus<TContract, TStatus>,
                        TStatus,
                    >
                }[InferEndpointErrorStatus<TContract>],
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                HttpContractError<InferEndpointErrorResponse<TContract>, number>,
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                ResponseContractError<
                    InferEndpointErrorResponse<TContract>,
                    number | undefined,
                >,
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
Check whether an unknown error is a ContractError for this endpoint.
Type Parameters
- Status extends number
- Source extends ContractErrorSource
- C extends never
Parameters
- err: unknown
- criteria: { code: C; source: Source; status: Status }
Returns err is
    | Extract<
        Extract<
            Extract<ClientContractError, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<NetworkContractError, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<EndpointCatalogContractError<TContract>, { status: Status }>,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                {
                    [TStatus in number]: HttpContractError<
                        InferEndpointErrorResponseByStatus<TContract, TStatus>,
                        TStatus,
                    >
                }[InferEndpointErrorStatus<TContract>],
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                HttpContractError<InferEndpointErrorResponse<TContract>, number>,
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
    | Extract<
        Extract<
            Extract<
                ResponseContractError<
                    InferEndpointErrorResponse<TContract>,
                    number | undefined,
                >,
                { status: Status },
            >,
            { source: Source },
        >,
        { code: C },
    >
- Defined in packages/core/src/client/client.ts:533

safeCall

safeCall(
...callArgs: CallArgs<TContract, TProvidedHeaders>,
): Promise<EndpointResult<TContract, InferEndpointContractError<TContract>>>
Call the endpoint and return a typed result instead of throwing ContractError.
Parameters
- ...callArgs: CallArgs<TContract, TProvidedHeaders>
Returns Promise<EndpointResult<TContract, InferEndpointContractError<TContract>>>
- Defined in packages/core/src/client/client.ts:576

Class Endpoint<TContract, TProvidedHeaders>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Endpoint<TContract, TProvidedHeaders>

Methods

call

Parameters

Returns Promise<InferSuccessResponse<TContract>>

isError

Parameters

Returns err is InferEndpointContractError<TContract>

Type Parameters

Parameters

Type Parameters

Parameters

Returns err is HttpContractError<unknown, S>

Type Parameters

Parameters

Type Parameters

Parameters

Type Parameters

Parameters

Returns err is | Extract<EndpointCatalogContractError<TContract>, { code: C }> | Extract< { [TStatus in number]: HttpContractError< InferEndpointErrorResponseByStatus<TContract, TStatus>, TStatus, > }[InferEndpointErrorStatus<TContract>], { code: C }, >

Type Parameters

Parameters

Returns err is InferEndpointContractError<TContract> & { code: C }

Type Parameters

Parameters

Type Parameters

Parameters

Type Parameters

Parameters

Type Parameters

Parameters

safeCall

Parameters

Returns Promise<EndpointResult<TContract, InferEndpointContractError<TContract>>>

Settings

On This Page

Returns err is
| Extract<EndpointCatalogContractError<TContract>, { code: C }>
| Extract<
{
[TStatus in number]: HttpContractError<
InferEndpointErrorResponseByStatus<TContract, TStatus>,
TStatus,
>
}[InferEndpointErrorStatus<TContract>],
{ code: C },
>