@socketsecurity/lib/dist/url.d.ts

Core utilities and infrastructure for Socket.dev security tools

/**
 * Check if a value is a valid URL.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function isUrl(value: string | URL | null | undefined): boolean;
/**
 * Parse a value as a URL.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function parseUrl(value: string | URL): URL | undefined;
/**
 * Convert a URL search parameter to an array.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamAsArray(value: string | null | undefined): string[];
export interface UrlSearchParamAsBooleanOptions {
    defaultValue?: boolean;
}
/**
 * Convert a URL search parameter to a boolean.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamAsBoolean(value: string | null | undefined, options?: UrlSearchParamAsBooleanOptions | undefined): boolean;
/**
 * Helper to get array from URLSearchParams.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamsGetArray(params: URLSearchParams | null | undefined, key: string): string[];
export interface UrlSearchParamsGetBooleanOptions {
    defaultValue?: boolean;
}
/**
 * Helper to get boolean from URLSearchParams.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamsGetBoolean(params: URLSearchParams | null | undefined, key: string, options?: UrlSearchParamsGetBooleanOptions | undefined): boolean;
export interface CreateRelativeUrlOptions {
    base?: string;
}
/**
 * Create a relative URL for testing.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function createRelativeUrl(path: string, options?: CreateRelativeUrlOptions | undefined): string;
export interface UrlSearchParamAsStringOptions {
    defaultValue?: string;
}
/**
 * Get string value from URLSearchParams with a default.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamAsString(params: URLSearchParams | null | undefined, key: string, options?: UrlSearchParamAsStringOptions | undefined): string;
export interface UrlSearchParamAsNumberOptions {
    defaultValue?: number;
}
/**
 * Get number value from URLSearchParams with a default.
 */
/*@__NO_SIDE_EFFECTS__*/
export declare function urlSearchParamAsNumber(params: URLSearchParams | null | undefined, key: string, options?: UrlSearchParamAsNumberOptions | undefined): number;