@eleven-am/faker
    Preparing search index...

    Interface UrlOptions

    interface UrlOptions {
        domain?: string | string[];
        extensions?: string[];
        includeHash?: boolean;
        includeQueryParams?: boolean;
        path?: string;
        protocol?: "http" | "https" | ("http" | "https")[];
        secure?: boolean;
    }
    Index

    Properties

    domain? extensions? includeHash? includeQueryParams? path? protocol? secure?

    Properties

    domain?: string | string[]

    Specific domain or array of domains to choose from. Defaults to generated domain.

    extensions?: string[]

    Array of possible file extensions to append to the path.

    includeHash?: boolean

    Include a random hash fragment (e.g., #section). Defaults to false (randomly decided).

    includeQueryParams?: boolean

    Include random query parameters (e.g., ?key=value). Defaults to false (randomly decided).

    path?: string

    Specific path part. Defaults to a randomly generated path segment.

    protocol?: "http" | "https" | ("http" | "https")[]

    Specific protocol or array ('http', 'https') to choose from. Defaults to 'https' bias.

    secure?: boolean

    Force HTTPS protocol. Overrides protocol option if true.

    Settings

    Member Visibility

    On This Page

    Properties