Function fetchEndpoint

fetchEndpoint<
    const EndpointToFetch extends
        | typeof NoParam
        | Readonly<
            {
                methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
                path: `/${string}`;
                requestDataShape: Shape | undefined;
                responseDataShape: Shape | undefined;
                service: { serviceName: string; serviceOrigin: string };
            },
        >,
>(
    endpoint: EndpointToFetch extends EndpointDefinition
        ? EndpointToFetch<EndpointToFetch>
        : {
            methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
            path: `/${string}`;
            requestDataShape: Shape | undefined;
            responseDataShape: Shape | undefined;
            searchParamsShape: Shape<unknown> | undefined;
            service: { serviceName: string; serviceOrigin: string };
        },
    ...params: CollapsedFetchEndpointParams<EndpointToFetch>,
): Promise<FetchEndpointOutput<EndpointToFetch>>
Send a request to an endpoint definition with type safe parameters.

This can safely be used in frontend or backend code.
Type Parameters
- const EndpointToFetch extends
      | typeof NoParam
      | Readonly<
          {
              methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
              path: `/${string}`;
              requestDataShape: Shape | undefined;
              responseDataShape: Shape | undefined;
              service: { serviceName: string; serviceOrigin: string };
          },
      >
Parameters
- endpoint: EndpointToFetch extends EndpointDefinition
      ? EndpointToFetch<EndpointToFetch>
      : {
          methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
          path: `/${string}`;
          requestDataShape: Shape | undefined;
          responseDataShape: Shape | undefined;
          searchParamsShape: Shape<unknown> | undefined;
          service: { serviceName: string; serviceOrigin: string };
      }
- ...params: CollapsedFetchEndpointParams<EndpointToFetch>
Returns Promise<FetchEndpointOutput<EndpointToFetch>>
Example
```
import {fetchEndpoint} from '@rest-vir/define-service';

const {data, response} = await fetchEndpoint(myService.endpoints['/my-endpoint']);
```
Package
@rest-vir/define-service
- Defined in packages/define-service/src/frontend-connect/fetch-endpoint.ts:291

Function fetchEndpoint

Type Parameters

Parameters

Returns Promise<FetchEndpointOutput<EndpointToFetch>>

Example

Package

Settings