Search
Preparing search index...
The search index is not available
Cognite JavaScript SDK (beta)
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"core/src/httpClient/cdfHttpClient"
CDFHttpClient
Class CDFHttpClient
Hierarchy
RetryableHttpClient
CDFHttpClient
Index
Constructors
constructor
Methods
add
One
Time
Header
delete
get
get
Base
Url
get
Default
Headers
patch
post
put
set401
Response
Handler
set
Base
Url
set
Bearer
Token
set
Cluster
set
Default
Header
Constructors
constructor
new CDFHttp
Client
(
baseUrl
:
string
, retryValidator
:
RetryValidator
)
:
CDFHttpClient
Parameters
baseUrl:
string
retryValidator:
RetryValidator
Returns
CDFHttpClient
Methods
add
One
Time
Header
add
One
Time
Header
(
name
:
string
, value
:
string
)
:
this
Parameters
name:
string
value:
string
Returns
this
delete
delete<ResponseType>
(
path
:
string
, options
?:
RetryableHttpRequestOptions
)
:
Promise
<
HttpResponse
<
ResponseType
>
>
Type parameters
ResponseType
Parameters
path:
string
Default value
options:
RetryableHttpRequestOptions
= {}
Returns
Promise
<
HttpResponse
<
ResponseType
>
>
get
get<ResponseType>
(
path
:
string
, options
?:
RetryableHttpRequestOptions
)
:
Promise
<
HttpResponse
<
ResponseType
>
>
Type parameters
ResponseType
Parameters
path:
string
Default value
options:
RetryableHttpRequestOptions
= {}
Returns
Promise
<
HttpResponse
<
ResponseType
>
>
get
Base
Url
get
Base
Url
(
)
:
string
Returns
string
get
Default
Headers
get
Default
Headers
(
)
:
HttpHeaders
Returns
HttpHeaders
patch
patch<ResponseType>
(
path
:
string
, options
?:
RetryableHttpRequestOptions
)
:
Promise
<
HttpResponse
<
ResponseType
>
>
Type parameters
ResponseType
Parameters
path:
string
Default value
options:
RetryableHttpRequestOptions
= {}
Returns
Promise
<
HttpResponse
<
ResponseType
>
>
post
post<ResponseType>
(
path
:
string
, options
?:
RetryableHttpRequestOptions
)
:
Promise
<
HttpResponse
<
ResponseType
>
>
Type parameters
ResponseType
Parameters
path:
string
Default value
options:
RetryableHttpRequestOptions
= {}
Returns
Promise
<
HttpResponse
<
ResponseType
>
>
put
put<ResponseType>
(
path
:
string
, options
?:
RetryableHttpRequestOptions
)
:
Promise
<
HttpResponse
<
ResponseType
>
>
Type parameters
ResponseType
Parameters
path:
string
Default value
options:
RetryableHttpRequestOptions
= {}
Returns
Promise
<
HttpResponse
<
ResponseType
>
>
set401
Response
Handler
set401
Response
Handler
(
handler
:
Response401Handler
)
:
void
Parameters
handler:
Response401Handler
Returns
void
set
Base
Url
set
Base
Url
(
baseUrl
:
string
)
:
void
Parameters
baseUrl:
string
Returns
void
set
Bearer
Token
set
Bearer
Token
(
token
:
string
)
:
void
Parameters
token:
string
Returns
void
set
Cluster
set
Cluster
(
cluster
:
string
)
:
void
Parameters
cluster:
string
Returns
void
set
Default
Header
set
Default
Header
(
name
:
string
, value
:
string
)
:
this
Parameters
name:
string
value:
string
Returns
this
Globals
"core/src/http
Client/cdf
Http
Client"
CDFHttp
Client
constructor
add
One
Time
Header
delete
get
get
Base
Url
get
Default
Headers
patch
post
put
set401
Response
Handler
set
Base
Url
set
Bearer
Token
set
Cluster
set
Default
Header
Response401
Handler