@promptbook/remote-server/esm/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { string_url } from '../../../types/string_url';
import type { IsHostnameOnPrivateNetworkOptions } from './isHostnameOnPrivateNetwork';
/**
 * Options for `isUrlOnPrivateNetwork`
 */
export type IsUrlOnPrivateNetworkOptions = IsHostnameOnPrivateNetworkOptions;
/**
 * Checks if an IP address or hostname is reserved for private networks or localhost.
 *
 * Note: There are two similar functions:
 * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
 * - `isHostnameOnPrivateNetwork` which tests just hostname
 *
 * @param {string} url - The URL to check.
 * @param {IsUrlOnPrivateNetworkOptions} options - Options for the check.
 * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
 *
 * @public exported from `@promptbook/utils`
 */
export declare function isUrlOnPrivateNetwork(url: URL | string_url, options?: IsUrlOnPrivateNetworkOptions): boolean;