fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
4.2 KiB
4.2 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: Client
internal.Client
Properties
axiosClient
• Private axiosClient: AxiosInstance
Defined in
config
• Private config: Config
Defined in
Methods
createClient
▸ createClient(config): AxiosInstance
Creates the axios client used for requests As part of the creation, we configure the retry conditions and the exponential backoff approach.
Parameters
| Name | Type | Description |
|---|---|---|
config |
Config |
user supplied configurations |
Returns
Defined in
normalizeHeader
▸ normalizeHeader(header): string
Parameters
| Name | Type |
|---|---|
header |
string |
Returns
string
Defined in
normalizeHeaders
▸ normalizeHeaders(obj): Record<string, any>
Parameters
| Name | Type |
|---|---|
obj |
object |
Returns
Record<string, any>
Defined in
request
▸ request(method, path, payload?, options?, customHeaders?): Promise<any>
Axios request
Parameters
| Name | Type | Description |
|---|---|---|
method |
RequestMethod |
request method |
path |
string |
request path |
payload |
Record<string, any> |
request payload |
options |
RequestOptions |
axios configuration |
customHeaders |
Record<string, any> |
custom request headers |
Returns
Promise<any>
Defined in
requiresAuthentication
▸ requiresAuthentication(path, method): boolean
Parameters
| Name | Type |
|---|---|
path |
any |
method |
any |
Returns
boolean
Defined in
setHeaders
▸ setHeaders(userHeaders, method, path, customHeaders?): AxiosRequestHeaders
Creates all the initial headers. We add the idempotency key, if the request is configured to retry.
Parameters
| Name | Type | Description |
|---|---|---|
userHeaders |
RequestOptions |
user supplied headers |
method |
RequestMethod |
request method |
path |
string |
request path |
customHeaders |
Record<string, any> |
user supplied headers |
Returns
Defined in
shouldRetryCondition
▸ shouldRetryCondition(err, numRetries, maxRetries): boolean
Parameters
| Name | Type |
|---|---|
err |
AxiosError<any, any> |
numRetries |
number |
maxRetries |
number |
Returns
boolean