Hierarchy

  • default

Properties

client_ip?: string | InOperatorCriteriaValue<string>

Matches a request based on the client ip variable value(s).

cookies?: {
    [name: string]: OptionalCriteriaValue | InOperatorCriteriaValue;
}

Matches a request based on one or more cookie values. Keys are case-sensitive cookie names, values are regular expressions to match or null. When value is null then requests are matched for the cookie not being present.

Type declaration

device?: {
    brand_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    device_os: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    dual_orientation: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    html_preferred_dtd: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    image_inlining: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_android: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_app: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_full_desktop: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_ios: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_robot: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_smartphone: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_smarttv: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_tablet: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_touchscreen: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_windows_phone: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_wireless_device: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    marketing_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    mobile_browser: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    model_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    progressive_download: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    release_date: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resolution_height: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resolution_width: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
}

Type declaration

headers?: {
    [name: string]: OptionalCriteriaValue | InOperatorCriteriaValue;
}

Matches a request based on one or more header values. Keys are case-insensitive header names, values are regular expressions to match or null. When value is null then requests are matched for the header not being present.

Type declaration

location?: {
    asn: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    city: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    continent: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    country: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    dma_code: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    latitude: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    longitude: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    metro_code: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    postal_code: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    region_code: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
}

Type declaration

Matches a request based on the HTTP method. Instead of this, prefer using get, post, put, delete, options, and patch methods.

Matches a request based on the origin path (the path after rewrites).

Example

"/products/:id"

Example

/^/products/(.+)$/

Matches a request based on the path. The same path syntax is used by the simple form of the Router class's match method. The path can be an express-style path expression or regular expression. Both express-style path and regular expression need to match the entire path including the leading slash.

Example

"/products/:id"

Example

/^/products/(.+)$/
pop_code?: string | InOperatorCriteriaValue<string>
query?: {
    [name: string]: OptionalCriteriaValue | InOperatorCriteriaValue;
}

Matches a request based on one or more query parameter values. Keys are case-sensitive names, values are regular expressions to match or null. When value is null then requests are matched for the query parameter not being present.

Type declaration

random?: number | InOperatorCriteriaValue<number>
referring-domain?: string | InOperatorCriteriaValue<string>

Matches a request based on the referring-domain variable value(s).

response?: RouteCriteriaResponse

Matches properties of the response response.

Matches a request based on its protocol / scheme. Unless explicitly specified then https is the default. To serve a route on both HTTPS and HTTP you can specify /https?/ regex. If an HTTP request is not matched against any route, Edgio will automatically issue a redirect to equivalent HTTPS URL.

variable?: {
    cache_status: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    content_length: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    country_code: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    geo_country: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    geo_region: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    host: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    http_x_forwarded_host: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_origin_shield: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    is_subrequest: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    matched_origin_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    matched_property_index: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    popcode: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    query_string: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    request_uri: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_age: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_content_type: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_edgecast_control: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_location: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_set_cookie: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_transfer_encoding: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_vary: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    resp_x_cache: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    status: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    uri: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    usrvar_enable_debug: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    usrvar_enable_options_resp: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    usrvar_enable_sf_debug: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    usrvar_options: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    virt_dst_addr: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    virt_http_version: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    wurfl_cap_brand_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    wurfl_cap_device_os_version: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    wurfl_cap_marketing_name: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    wurfl_cap_resolution_height: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
    wurfl_vcap_is_ios: undefined | OptionalCriteriaValue | InOperatorCriteriaValue<string>;
}

Matches a request based on the variable value.

Type declaration

Generated using TypeDoc