rest-vir - v1.0.0
    Preparing search index...

    Function fetchEndpoint

    • 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: undefined | ShapeDefinition<any, true>;
                    responseDataShape: undefined | ShapeDefinition<any, true>;
                    service: { serviceName: string; serviceOrigin: string };
                },
            >

      Parameters

      • endpoint: EndpointToFetch extends EndpointDefinition
            ? EndpointToFetch<EndpointToFetch>
            : {
                methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
                path: `/${string}`;
                requestDataShape: undefined | ShapeDefinition<any, true>;
                responseDataShape: undefined | ShapeDefinition<any, true>;
                searchParamsShape: undefined | ShapeDefinition<unknown, true>;
                service: { serviceName: string; serviceOrigin: string };
            }
      • ...params: CollapsedFetchEndpointParams<EndpointToFetch>

      Returns Promise<FetchEndpointOutput<EndpointToFetch>>

      import {fetchEndpoint} from '@rest-vir/define-service';

      const {data, response} = await fetchEndpoint(myService.endpoints['/my-endpoint']);

      @rest-vir/define-service

    Settings

    Member Visibility