Skip to main content

RequestOptions

Options that can be used to customize request creation.

This type exactly matches the parameters of Request.from_url method.

Index

Properties

always_enqueue

always_enqueue: NotRequired[bool]

headers

headers: NotRequired[(HttpHeaders | dict[str, str]) | None]

id

id: NotRequired[str | None]

keep_url_fragment

keep_url_fragment: NotRequired[bool]

label

label: NotRequired[str | None]

method

method: NotRequired[HttpMethod]

no_retry

no_retry: NotRequired[bool]

payload

payload: NotRequired[(HttpPayload | str) | None]

unique_key

unique_key: NotRequired[str | None]

url

url: Required[str]

use_extended_unique_key

use_extended_unique_key: NotRequired[bool]

user_data

user_data: NotRequired[dict[str, JsonSerializable]]