Function buildEndpointUrl

buildEndpointUrl<
    const EndpointToFetch extends
        | typeof NoParam
        | Readonly<
            {
                methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
                path: `/${string}`;
                requestDataShape: Shape | undefined;
                responseDataShape: Shape | undefined;
                searchParamsShape: Shape<unknown> | undefined;
                service: { serviceName: string; serviceOrigin: string };
            },
        > = typeof NoParam,
>(
    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 };
        },
    __namedParameters: Pick<
        EndpointToFetch extends NoParam
            ? Readonly<GenericFetchEndpointParams>
            : Readonly<FetchEndpointParams<Exclude<EndpointToFetch, NoParam>>>,
        "pathParams" | "searchParams" | "wildcard",
    >,
): string
Creates and finalizes a URL for sending fetches to the given endpoint.
Type Parameters
- const EndpointToFetch extends
      | typeof NoParam
      | Readonly<
          {
              methods: _RequireAtLeastOne<Record<HttpMethod, boolean>, HttpMethod>;
              path: `/${string}`;
              requestDataShape: Shape | undefined;
              responseDataShape: Shape | undefined;
              searchParamsShape: Shape<unknown> | undefined;
              service: { serviceName: string; serviceOrigin: string };
          },
      > = typeof NoParam
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 };
      }
- __namedParameters: Pick<
      EndpointToFetch extends NoParam
          ? Readonly<GenericFetchEndpointParams>
          : Readonly<FetchEndpointParams<Exclude<EndpointToFetch, NoParam>>>,
      "pathParams" | "searchParams" | "wildcard",
  >
Returns string
Package
@rest-vir/define-service
- Defined in packages/define-service/src/frontend-connect/fetch-endpoint.ts:476

Function buildEndpointUrl

Type Parameters

Parameters

Returns string

Package

Settings