Interface WebUrlConstraints

Constraints to be applied on webUrl

Remarks

Since 1.14.0

interface WebUrlConstraints {
    authoritySettings?: WebAuthorityConstraints;
    size?: Size | RelativeSize;
    validSchemes?: string[];
    withFragments?: boolean;
    withQueryParameters?: boolean;
}

Properties

authoritySettings? size? validSchemes? withFragments? withQueryParameters?

Properties

Optional authoritySettings

authoritySettings?: WebAuthorityConstraints

Settings for webAuthority

Default Value

{}

Remarks

Since 1.14.0

Optional size

size?: Size | RelativeSize

Define how large the generated values should be (at max)

Remarks

Since 2.22.0

Optional validSchemes

validSchemes?: string[]

Enforce specific schemes, eg.: http, https

Default Value

['http', 'https']

Remarks

Since 1.14.0

Optional withFragments

withFragments?: boolean

Enable fragments in the generated url

Default Value

false

Remarks

Since 1.14.0

Optional withQueryParameters

withQueryParameters?: boolean

Enable query parameters in the generated url

Default Value

false

Remarks

Since 1.14.0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc