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
content-api/src
HaloRequestConfigBuilder
Class HaloRequestConfigBuilder
Hierarchy
HaloRequestConfigBuilder
Implements
<internal>
.
RequestConfigBuilder
Index
Constructors
constructor
Properties
auth
base
Url
build
Data
build
Headers
build
Request
Url
client
Cert
Auth
get
Request
Token
headers
proxy
request
Token
Methods
build
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
?:
any
Private
Readonly
base
Url
base
Url
:
any
Private
build
Data
build
Data
:
any
Private
build
Headers
build
Headers
:
any
Private
build
Request
Url
build
Request
Url
:
any
Private
Optional
Readonly
client
Cert
Auth
client
Cert
Auth
?:
any
Private
get
Request
Token
get
Request
Token
:
any
Private
Readonly
headers
headers
:
any
Private
Optional
Readonly
proxy
proxy
?:
any
Private
request
Token
request
Token
:
any
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
}
>
Modules
admin-
api/src
content-
api/src
<internal>
logger/src
rest-
api-
client/src
Halo
Request
Config
Builder
constructor
auth
base
Url
build
Data
build
Headers
build
Request
Url
client
Cert
Auth
get
Request
Token
headers
proxy
request
Token
build
Generated using
TypeDoc