Search
Preparing search index...
The search index is not available
typescript
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"node_modules/@types/request/index.d"
request
DefaultUriUrlRequestApi
Interface DefaultUriUrlRequestApi<TRequest, TOptions, TUriUrlOptions>
Type parameters
TRequest
:
Request
TOptions
:
CoreOptions
TUriUrlOptions
Hierarchy
RequestAPI
<
TRequest
,
TOptions
,
TUriUrlOptions
>
DefaultUriUrlRequestApi
Callable
__call
(
callback
?:
RequestCallback
)
:
TRequest
__call
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
__call
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
__call
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Index
Properties
debug
Methods
cookie
defaults
del
delete
forever
get
head
init
Params
jar
patch
post
put
Properties
debug
debug
:
boolean
Methods
cookie
cookie
(
str
:
string
)
:
Cookie
|
undefined
Parameters
str:
string
Returns
Cookie
|
undefined
defaults
defaults
(
options
:
TOptions
)
:
DefaultUriUrlRequestApi
<
TRequest
,
TOptions
,
OptionalUriUrl
>
Parameters
options:
TOptions
Returns
DefaultUriUrlRequestApi
<
TRequest
,
TOptions
,
OptionalUriUrl
>
del
del
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
del
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
del
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
del
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
delete
delete
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
delete
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
delete
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
delete
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
forever
forever
(
agentOptions
:
any
, optionsArg
:
any
)
:
TRequest
Parameters
agentOptions:
any
optionsArg:
any
Returns
TRequest
get
get
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
get
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
get
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
get
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
head
head
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
head
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
head
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
head
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
init
Params
init
Params
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
RequiredUriUrl
&
TOptions
init
Params
(
uriOrOpts
:
string
|
RequiredUriUrl
&
TOptions
, callback
?:
RequestCallback
)
:
RequiredUriUrl
&
TOptions
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
RequiredUriUrl
&
TOptions
Parameters
uriOrOpts:
string
|
RequiredUriUrl
&
TOptions
Optional
callback:
RequestCallback
Returns
RequiredUriUrl
&
TOptions
jar
jar
(
store
?:
any
)
:
CookieJar
Parameters
Optional
store:
any
Returns
CookieJar
patch
patch
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
patch
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
patch
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
patch
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
post
post
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
post
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
post
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
post
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
put
put
(
uri
:
string
, options
?:
TOptions
, callback
?:
RequestCallback
)
:
TRequest
put
(
uri
:
string
, callback
?:
RequestCallback
)
:
TRequest
put
(
options
:
TUriUrlOptions
&
TOptions
, callback
?:
RequestCallback
)
:
TRequest
put
(
callback
?:
RequestCallback
)
:
TRequest
Parameters
uri:
string
Optional
options:
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
uri:
string
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
options:
TUriUrlOptions
&
TOptions
Optional
callback:
RequestCallback
Returns
TRequest
Parameters
Optional
callback:
RequestCallback
Returns
TRequest
Globals
"node_
modules/@types/request/index.d"
request
AWSOptions
Auth
Options
Cookie
Jar
Core
Options
Default
Uri
Url
Request
Api
debug
cookie
defaults
del
delete
forever
get
head
init
Params
jar
patch
post
put
Hawk
Options
Headers
Http
Archive
Request
Multipart
Name
Value
Pair
OAuth
Options
Request
RequestAPI
Request
AsJSON
Request
Part
Response
Response
AsJSON
Uri
Options
Url
Options
Cookie
Optional
Uri
Url
Options
Options
With
Uri
Options
With
Url
Request
Callback
Request
Response
Required
Uri
Url
Response
Request
Generated using
TypeDoc