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,186 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Client
[internal](../modules/internal.md).Client
## Properties
### axiosClient
`Private` **axiosClient**: [`AxiosInstance`](../interfaces/internal.AxiosInstance.md)
#### Defined in
[medusa-js/src/request.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L34)
___
### config
`Private` **config**: [`Config`](../interfaces/internal.Config.md)
#### Defined in
[medusa-js/src/request.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L35)
## Methods
### createClient
**createClient**(`config`): [`AxiosInstance`](../interfaces/internal.AxiosInstance.md)
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`](../interfaces/internal.Config.md) | user supplied configurations |
#### Returns
[`AxiosInstance`](../interfaces/internal.AxiosInstance.md)
#### Defined in
[medusa-js/src/request.ts:158](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L158)
___
### normalizeHeader
**normalizeHeader**(`header`): `string`
#### Parameters
| Name | Type |
| :------ | :------ |
| `header` | `string` |
#### Returns
`string`
#### Defined in
[medusa-js/src/request.ts:88](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L88)
___
### normalizeHeaders
**normalizeHeaders**(`obj`): `Record`<`string`, `any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `obj` | `object` |
#### Returns
`Record`<`string`, `any`\>
#### Defined in
[medusa-js/src/request.ts:76](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L76)
___
### request
**request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\>
Axios request
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method |
| `path` | `string` | request path |
| `payload` | `Record`<`string`, `any`\> | request payload |
| `options` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | axios configuration |
| `customHeaders` | `Record`<`string`, `any`\> | custom request headers |
#### Returns
`Promise`<`any`\>
#### Defined in
[medusa-js/src/request.ts:195](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L195)
___
### requiresAuthentication
**requiresAuthentication**(`path`, `method`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `any` |
| `method` | `any` |
#### Returns
`boolean`
#### Defined in
[medusa-js/src/request.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L97)
___
### setHeaders
**setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
Creates all the initial headers.
We add the idempotency key, if the request is configured to retry.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userHeaders` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | user supplied headers |
| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method |
| `path` | `string` | request path |
| `customHeaders` | `Record`<`string`, `any`\> | user supplied headers |
#### Returns
[`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders)
#### Defined in
[medusa-js/src/request.ts:113](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L113)
___
### shouldRetryCondition
**shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](../interfaces/internal.AxiosError.md)<`any`, `any`\> |
| `numRetries` | `number` |
| `maxRetries` | `number` |
#### Returns
`boolean`
#### Defined in
[medusa-js/src/request.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L45)