@scalar/api-client/dist/v2/blocks/operation-block/helpers/get-resolved-url.d.ts

the open source API testing client

import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server';
/**
 * Resolves and constructs the final request URL using the provided environment, server, path,
 * path variables, and optional query parameters.
 *
 * - Environment variables and path variables are used to replace placeholders in the path string.
 * - The server URL is dynamically resolved (may apply env variables).
 * - urlParams are optionally appended as the query string.
 *
 * @param environment    The current environment containing variable values.
 * @param server         The selected server object; can be null.
 * @param path           The raw path string from the OpenAPI document (may contain variables).
 * @param pathVariables  Map of path variable values (e.g., { petId: '5' }).
 * @param urlParams      Optional query parameters as URLSearchParams.
 * @returns              Fully resolved URL as a string.
 */
export declare const getResolvedUrl: ({ environment, server, path, pathVariables, urlParams, }: {
    environment: XScalarEnvironment;
    server: ServerObject | null;
    path: string;
    pathVariables: Record<string, string>;
    urlParams?: URLSearchParams;
}) => string;
//# sourceMappingURL=get-resolved-url.d.ts.map