@scalar/api-client
Version:
the open source API testing client
17 lines • 983 B
TypeScript
import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/parameter';
/**
* Retrieves a parameter from an operation's parameters by name and type ('in').
* This is typically used to find a particular header, query, path, or cookie parameter.
*
* @param operation - The operation object containing the parameters array.
* @param name - The name of the parameter to search for (case-insensitive).
* @param type - The parameter location (e.g., 'header', 'query', 'path', 'cookie').
* @returns The found parameter object, or null if not found.
*/
export declare const getOperationHeader: ({ operation, name, type, }: {
operation: OperationObject;
name: string;
type: ParameterObject["in"];
}) => import("@scalar/workspace-store/schemas/v3.1/strict/reference").ReferenceType<ParameterObject> | null;
//# sourceMappingURL=get-operation-header.d.ts.map