Search
Preparing search index...
The search index is not available
@michaelcoxon/rest-client - v1.6.0
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"xhr/XhrHttpRequestResponse"
XhrHttpResponse
Class XhrHttpResponse
Hierarchy
XhrHttpResponse
XhrErrorHttpResponse
Implements
IHttpResponse
Index
Constructors
constructor
Properties
_cancelled
_filters
_lazy
Content
Async
_lazy
Headers
_lazy
Ok
_lazy
Status
_lazy
Status
Text
_lazyresponse
_lazyresponse
Type
_request
should
Retry
Accessors
cancelled
content
Async
headers
ok
request
response
response
Type
status
status
Text
Methods
execute
Async
_create
Http
Response
Header
Collection
_map
Response
Type
Constructors
constructor
new
Xhr
Http
Response
(
filters
?:
IHttpFilter
[]
)
:
XhrHttpResponse
Parameters
Default value
filters:
IHttpFilter
[]
= []
Returns
XhrHttpResponse
Properties
Private
_cancelled
_cancelled
:
boolean
Private
_filters
_filters
:
IHttpFilter
[]
Private
_lazy
Content
Async
_lazy
Content
Async
:
LazyAsync
<
IHttpResponseContent
>
Private
_lazy
Headers
_lazy
Headers
:
Lazy
<
IHttpResponseHeaderCollection
>
Private
_lazy
Ok
_lazy
Ok
:
Lazy
<
boolean
>
Private
_lazy
Status
_lazy
Status
:
Lazy
<
HttpStatusCode
>
Private
_lazy
Status
Text
_lazy
Status
Text
:
Lazy
<
string
>
Private
_lazyresponse
_lazyresponse
:
Lazy
<
any
>
Private
_lazyresponse
Type
_lazyresponse
Type
:
Lazy
<
HttpResponseType
>
Private
Optional
_request
_request
:
XhrHttpRequest
should
Retry
should
Retry
:
boolean
= false
Accessors
cancelled
get
cancelled
(
)
:
boolean
Returns
boolean
content
Async
get
contentAsync
(
)
:
Promise
<
IHttpResponseContent
>
Returns
Promise
<
IHttpResponseContent
>
headers
get
headers
(
)
:
IHttpResponseHeaderCollection
Returns
IHttpResponseHeaderCollection
ok
get
ok
(
)
:
boolean
Returns
boolean
request
get
request
(
)
:
Readonly
<
IHttpRequest
>
Returns
Readonly
<
IHttpRequest
>
response
get
response
(
)
:
any
Returns
any
response
Type
get
responseType
(
)
:
HttpResponseType
Returns
HttpResponseType
status
get
status
(
)
:
HttpStatusCode
Returns
HttpStatusCode
status
Text
get
statusText
(
)
:
string
Returns
string
Methods
execute
Async
execute
Async
(
request
:
IHttpRequest
, cancelled
?:
boolean
)
:
Promise
<
void
>
Parameters
request:
IHttpRequest
Default value
cancelled:
boolean
= false
Returns
Promise
<
void
>
Static
Private
_create
Http
Response
Header
Collection
_create
Http
Response
Header
Collection
(
xhrHeaders
:
string
)
:
IHttpResponseHeaderCollection
Parameters
xhrHeaders:
string
Returns
IHttpResponseHeaderCollection
Static
Private
_map
Response
Type
_map
Response
Type
(
xhrResponseType
:
XMLHttpRequestResponseType
)
:
HttpResponseType
Parameters
xhrResponseType:
XMLHttpRequestResponseType
Returns
HttpResponseType
Globals
"
Exceptions"
"
Header
Collection"
"
Http
Content
Header
Collection"
"
Http
Request
Header
Collection"
"
Http
Response
Header
Collection"
"
Request
Content"
"
Response
Content"
"
Response
Content
Handlers"
"
Types"
"filters/
Basic
Authentication
Filter"
"helpers/
Filter
Helpers"
"helpers/
Header
Helpers"
"index"
"interfaces/
Http
Client
Enums"
"interfaces/
Http
Client
Interfaces"
"xhr/
Xhr
Http
Client"
"xhr/
Xhr
Http
Request
Response"
Xhr
Error
Http
Response
Xhr
Http
Request
Xhr
Http
Response
constructor
_cancelled
_filters
_lazy
Content
Async
_lazy
Headers
_lazy
Ok
_lazy
Status
_lazy
Status
Text
_lazyresponse
_lazyresponse
Type
_request
should
Retry
cancelled
content
Async
headers
ok
request
response
response
Type
status
status
Text
execute
Async
_create
Http
Response
Header
Collection
_map
Response
Type
MUST_
EXECUTE_
RESPONSE_
FIRST_
MESSAGE
Generated using
TypeDoc