Version: Next

UrlPatternRequestOptions

Request options that the globs and pseudoUrls input editors can attach to a single URL pattern.

Hierarchy

Pick<RequestOptions, method | payload | label | userData | headers>
- UrlPatternRequestOptions
  - GlobInput
  - PseudoUrlInput

Index

Properties

headers
label
method
payload
userData

Properties

externaloptionalinheritedheaders

headers?: Record<string, string>

HTTP headers in the following format:

{
    Accept: 'text/html',
    'Content-Type': 'application/json'
}

externaloptionalinheritedlabel

label?: string

Shortcut for setting userData: { label: '...' }.

externaloptionalinheritedmethod

method?: AllowedHttpMethods = AllowedHttpMethods

externaloptionalinheritedpayload

payload?: string

HTTP request payload, e.g. for POST requests.

externaloptionalinheriteduserData

userData?: Dictionary

Custom user data assigned to the request. Use this to save any request related data to the request's scope, keeping them accessible on retries, failures etc.

All data stored in userData must be JSON-serializable. Storing non-serializable values (e.g. functions, symbols) may result in unexpected results.