Forest Admin - API reference
Preparing search index...
@forestadmin/agent-client
HttpRequester
Class HttpRequester
Index
Constructors
constructor
Methods
query
stream
escape
Url
Slug
Constructors
constructor
new
HttpRequester
(
token
:
string
,
options
:
{
prefix
?:
string
;
url
:
string
}
,
)
:
HttpRequester
Parameters
token
:
string
options
:
{
prefix
?:
string
;
url
:
string
}
Returns
HttpRequester
Methods
query
query
<
Data
=
unknown
>
(
__namedParameters
:
{
body
?:
Record
<
string
,
unknown
>
;
contentType
?:
"application/json"
|
"text/csv"
;
maxTimeAllowed
?:
number
;
method
:
"delete"
|
"get"
|
"post"
|
"put"
;
path
:
string
;
query
?:
Record
<
string
,
unknown
>
;
}
,
)
:
Promise
<
Data
>
Type Parameters
Data
=
unknown
Parameters
__namedParameters
:
{
body
?:
Record
<
string
,
unknown
>
;
contentType
?:
"application/json"
|
"text/csv"
;
maxTimeAllowed
?:
number
;
method
:
"delete"
|
"get"
|
"post"
|
"put"
;
path
:
string
;
query
?:
Record
<
string
,
unknown
>
;
}
Returns
Promise
<
Data
>
stream
stream
(
__namedParameters
:
{
contentType
:
"text/csv"
;
maxTimeAllowed
?:
number
;
path
:
string
;
query
?:
Record
<
string
,
unknown
>
;
stream
:
WriteStream
;
}
,
)
:
Promise
<
void
>
Parameters
__namedParameters
:
{
contentType
:
"text/csv"
;
maxTimeAllowed
?:
number
;
path
:
string
;
query
?:
Record
<
string
,
unknown
>
;
stream
:
WriteStream
;
}
Returns
Promise
<
void
>
Static
escape
Url
Slug
escapeUrlSlug
(
name
:
string
)
:
string
Parameters
name
:
string
Returns
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
query
stream
escape
Url
Slug
Forest Admin - API reference
Loading...