Class WebRequest
Hierarchy
- WebRequest
Implements
Index
Constructors
constructor
Returns WebRequest
Properties
Static Custom
Custom HTTP Request Headers to be sent with XMLHttpRequests i.e. when loading files, where the server/service expects an Authorization header
Type declaration
[key: string]: string
Static Custom
Add callback functions in this array to update all the requests before they get sent to the network
Static Skip
Accessors
onprogress
Gets or sets a function to be called when loading progress changes
Returns null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
Gets or sets a function to be called when loading progress changes
Parameters
value: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
Returns void
ready
Returns client's state
Returns number
response
Returns client's response
Returns any
response
Returns client's response as text
Returns string
response
Gets or sets the expected response type
Returns XMLHttpRequestResponseType
Gets or sets the expected response type
Parameters
value: XMLHttpRequestResponseType
Returns void
responseURL
Returns client's response url
Returns string
status
Returns client's status
Returns number
status
Returns client's status as a text
Returns string
timeout
Gets or sets the timeout value in milliseconds
Returns number
Gets or sets the timeout value in milliseconds
Parameters
value: number
Returns void
Static Is
This function can be called to check if there are request modifiers for network requests
Returns boolean
true if there are any custom requests available
Methods
abortSearch playground for abort
Cancels any network activity
Returns void
get
Get the string containing the text of a particular header's value.
Parameters
name: string
The name of the header
Returns Nullable<string>
The string containing the text of the given header name
openSearch playground for open
Sets the request method, request URL
Parameters
method: string
defines the method to use (GET, POST, etc..)
url: string
defines the url to connect with
Returns void
sendSearch playground for send
Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
Parameters
Optional body: null | Document | XMLHttpRequestBodyInit
defines an optional request body
Returns void
set
Sets the value of a request header.
Parameters
name: string
The name of the header whose value is to be set
value: string
The value to set as the body of the header
Returns void
Extended version of XMLHttpRequest with support for customizations (headers, ...)