@otakusan76/nestjs-environment-variables-provider - v1.0.6
    Preparing search index...

    Interface IsURLOptions

    Options to be passed to the UrlProperty decorator.

    interface IsURLOptions {
        allow_fragments?: boolean;
        allow_protocol_relative_URLs?: boolean;
        allow_query_components?: boolean;
        allow_trailing_dot?: boolean;
        allow_underscores?: boolean;
        disallow_auth?: boolean;
        host_blacklist?: (string | RegExp)[];
        host_whitelist?: (string | RegExp)[];
        max_allowed_length?: number | false;
        protocols?: string[];
        require_host?: boolean;
        require_port?: boolean;
        require_protocol?: boolean;
        require_tld?: boolean;
        require_valid_protocol?: boolean;
        validate_length?: boolean;
    }
    Index

    Properties

    allow_fragments? allow_protocol_relative_URLs? allow_query_components? allow_trailing_dot? allow_underscores? disallow_auth? host_blacklist? host_whitelist? max_allowed_length? protocols? require_host? require_port? require_protocol? require_tld? require_valid_protocol? validate_length?

    Properties

    allow_fragments?: boolean

    If allow_fragments is set to true, URLs may include fragments (e.g. #section).

    true
    allow_protocol_relative_URLs?: boolean

    If allow_protocol_relative_URLs is set to true, protocol-relative URLs (e.g. //example.com) will be accepted.

    false
    allow_query_components?: boolean

    If allow_query_components is set to true, URLs may contain query parameters (e.g. ?key=value).

    true
    allow_trailing_dot?: boolean

    If allow_trailing_dot is set to true, the URL may include a trailing dot in the host name.

    false
    allow_underscores?: boolean

    If allow_underscores is set to true, underscores will be permitted in the host name.

    false
    disallow_auth?: boolean

    If disallow_auth is set to true, URLs containing authentication (e.g. user:pass@) will be rejected.

    false
    host_blacklist?: (string | RegExp)[]

    If host_blacklist is set, any URL whose host matches one of the specified strings or regular expressions will be rejected.

    false
    host_whitelist?: (string | RegExp)[]

    If host_whitelist is set, only URLs whose host matches one of the strings or regular expressions in the list will be allowed.

    false
    max_allowed_length?: number | false

    If max_allowed_length is set, it defines the maximum number of characters allowed in the URL. If set to false, no length check will be applied.

    2084
    protocols?: string[]

    If protocols is set, only URLs using one of the specified protocols will be considered valid.

    ['http', 'https', 'ftp']
    require_host?: boolean

    If require_host is set to true, the URL must contain a valid host.

    true
    require_port?: boolean

    If require_port is set to true, the URL must include an explicit port number.

    false
    require_protocol?: boolean

    If require_protocol is set to true, the URL must include a protocol (e.g. http://).

    false
    require_tld?: boolean

    If require_tld is set to true, the validator will require the URL to include a top-level domain.

    true
    require_valid_protocol?: boolean

    If require_valid_protocol is set to true, the protocol must be one of the allowed values defined in protocols.

    true
    validate_length?: boolean

    If validate_length is set to true, the validator will enforce a maximum length on the URL.

    true

    Settings

    Member Visibility

    On This Page

    Properties