Search
Preparing search index...
The search index is not available
@halo-dev/js-sdk
Options
All
Public
Public/Protected
All
Inherited
Menu
@halo-dev/js-sdk
rest-api-client/src
HaloRequestConfigBuilder
Class HaloRequestConfigBuilder
Hierarchy
HaloRequestConfigBuilder
Implements
<internal>
.
RequestConfigBuilder
Index
Constructors
constructor
Properties
auth
base
Url
client
Cert
Auth
headers
proxy
request
Token
Methods
build
build
Data
build
Headers
build
Request
Url
get
Request
Token
Constructors
constructor
new
Halo
Request
Config
Builder
(
__namedParameters
:
{
auth
?:
DiscriminatedAuth
;
baseUrl
:
string
;
basicAuth
?:
BasicAuth
;
clientCertAuth
?:
{
password
:
string
;
pfx
:
Buffer
}
|
{
password
:
string
;
pfxFilePath
:
string
}
;
proxy
?:
<internal>
.
ProxyConfig
;
userAgent
?:
string
}
)
:
HaloRequestConfigBuilder
Parameters
__namedParameters:
{
auth
?:
DiscriminatedAuth
;
baseUrl
:
string
;
basicAuth
?:
BasicAuth
;
clientCertAuth
?:
{
password
:
string
;
pfx
:
Buffer
}
|
{
password
:
string
;
pfxFilePath
:
string
}
;
proxy
?:
<internal>
.
ProxyConfig
;
userAgent
?:
string
}
Optional
auth
?:
DiscriminatedAuth
base
Url
:
string
Optional
basic
Auth
?:
BasicAuth
Optional
client
Cert
Auth
?:
{
password
:
string
;
pfx
:
Buffer
}
|
{
password
:
string
;
pfxFilePath
:
string
}
Optional
proxy
?:
<internal>
.
ProxyConfig
Optional
user
Agent
?:
string
Returns
HaloRequestConfigBuilder
Properties
Private
Optional
Readonly
auth
auth
?:
DiscriminatedAuth
Private
Readonly
base
Url
base
Url
:
string
Private
Optional
Readonly
client
Cert
Auth
client
Cert
Auth
?:
{
password
:
string
;
pfx
:
Buffer
}
|
{
password
:
string
;
pfxFilePath
:
string
}
Private
Readonly
headers
headers
:
any
Private
Optional
Readonly
proxy
proxy
?:
<internal>
.
ProxyConfig
Private
request
Token
request
Token
:
null
|
string
Methods
build
build
(
method
:
<internal>
.
HttpMethod
, path
:
string
, params
:
<internal>
.
Data
, options
?:
<internal>
.
RequestOptions
)
:
Promise
<
{
data
?:
any
;
headers
:
any
;
httpsAgent
?:
any
;
method
:
<internal>
.
HttpMethod
;
proxy
?:
<internal>
.
ProxyConfig
;
url
:
string
}
>
Parameters
method:
<internal>
.
HttpMethod
path:
string
params:
<internal>
.
Data
Optional
options:
<internal>
.
RequestOptions
Returns
Promise
<
{
data
?:
any
;
headers
:
any
;
httpsAgent
?:
any
;
method
:
<internal>
.
HttpMethod
;
proxy
?:
<internal>
.
ProxyConfig
;
url
:
string
}
>
Private
build
Data
build
Data
<
T
>
(
params
:
T
)
:
Promise
<
T
>
Type parameters
T
:
<internal>
.
Data
Parameters
params:
T
Returns
Promise
<
T
>
Private
build
Headers
build
Headers
(
params
:
{
basicAuth
?:
BasicAuth
;
userAgent
?:
string
}
)
:
any
Parameters
params:
{
basicAuth
?:
BasicAuth
;
userAgent
?:
string
}
Optional
basic
Auth
?:
BasicAuth
Optional
user
Agent
?:
string
Returns
any
Private
build
Request
Url
build
Request
Url
(
path
:
string
, params
:
<internal>
.
Data
)
:
string
Parameters
path:
string
params:
<internal>
.
Data
Returns
string
Private
get
Request
Token
get
Request
Token
(
)
:
Promise
<
string
>
Returns
Promise
<
string
>
Modules
admin-
api/src
content-
api/src
logger/src
rest-
api-
client/src
<internal>
Halo
Request
Config
Builder
constructor
auth
base
Url
client
Cert
Auth
headers
proxy
request
Token
build
build
Data
build
Headers
build
Request
Url
get
Request
Token
Generated using
TypeDoc