docs: create docs workspace (#5174)

* 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
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions

View File

@@ -0,0 +1,195 @@
---
displayed_sidebar: jsClientSidebar
---
# Interface: RetryConfig
[internal](../modules/internal.md).RetryConfig
Configuration for the Axios `request` method.
## Properties
### backoffType
`Optional` **backoffType**: ``"linear"`` \| ``"static"`` \| ``"exponential"``
Backoff Type; 'linear', 'static' or 'exponential'.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47
___
### checkRetryAfter
• `Optional` **checkRetryAfter**: `boolean`
Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51
___
### currentRetryAttempt
• `Optional` **currentRetryAttempt**: `number`
The number of retries already attempted.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13
___
### httpMethodsToRetry
• `Optional` **httpMethodsToRetry**: `string`[]
The HTTP Methods that will be automatically retried.
Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26
___
### instance
• `Optional` **instance**: [`AxiosInstance`](internal.AxiosInstance.md)
The instance of the axios object to which the interceptor is attached.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21
___
### maxRetryAfter
• `Optional` **maxRetryAfter**: `number`
Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55
___
### maxRetryDelay
• `Optional` **maxRetryDelay**: `number`
Ceiling for calculated delay (in ms) - delay will not exceed this value.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59
___
### noResponseRetries
• `Optional` **noResponseRetries**: `number`
When there is no response, the number of retries to attempt. Defaults to 2.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43
___
### onRetryAttempt
• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `void`
#### Type declaration
▸ (`err`): `void`
Function to invoke when a retry attempt is made.
##### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
##### Returns
`void`
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35
___
### retry
• `Optional` **retry**: `number`
The number of times to retry the request. Defaults to 3.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9
___
### retryDelay
• `Optional` **retryDelay**: `number`
The amount of time to initially delay the retry. Defaults to 100.
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17
___
### shouldRetry
• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `boolean`
#### Type declaration
▸ (`err`): `boolean`
Function to invoke which determines if you should retry
##### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> |
##### Returns
`boolean`
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39
___
### statusCodesToRetry
• `Optional` **statusCodesToRetry**: `number`[][]
The HTTP response status codes that will automatically be retried.
Defaults to: [[100, 199], [429, 429], [500, 599]]
#### Defined in
medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31