docs: added reference for JS Client (#1629)

* added reference for JS Client * added reference for JS Client * added reference for JS Client
2022-07-08 18:21:46 +03:00
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions
--- a/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md
+++ b/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md
@@ -0,0 +1,507 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Interface: AxiosDefaults<D\>
+
+[internal](../modules/internal.md).AxiosDefaults
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `D` | `any` |
+
+## Hierarchy
+
+- [`Omit`](../modules/internal.md#omit)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\>
+
+  ↳ **`AxiosDefaults`**
+
+## Properties
+
+### adapter
+
+• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md)
+
+#### Inherited from
+
+Omit.adapter
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:75
+
+___
+
+### auth
+
+• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md)
+
+#### Inherited from
+
+Omit.auth
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:76
+
+___
+
+### baseURL
+
+• `Optional` **baseURL**: `string`
+
+#### Inherited from
+
+Omit.baseURL
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:65
+
+___
+
+### cancelToken
+
+• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md)
+
+#### Inherited from
+
+Omit.cancelToken
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:90
+
+___
+
+### data
+
+• `Optional` **data**: `D`
+
+#### Inherited from
+
+Omit.data
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:71
+
+___
+
+### decompress
+
+• `Optional` **decompress**: `boolean`
+
+#### Inherited from
+
+Omit.decompress
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:91
+
+___
+
+### headers
+
+• **headers**: [`HeadersDefaults`](internal.HeadersDefaults.md)
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:112
+
+___
+
+### httpAgent
+
+• `Optional` **httpAgent**: `any`
+
+#### Inherited from
+
+Omit.httpAgent
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:87
+
+___
+
+### httpsAgent
+
+• `Optional` **httpsAgent**: `any`
+
+#### Inherited from
+
+Omit.httpsAgent
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:88
+
+___
+
+### insecureHTTPParser
+
+• `Optional` **insecureHTTPParser**: `boolean`
+
+#### Inherited from
+
+Omit.insecureHTTPParser
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:94
+
+___
+
+### maxBodyLength
+
+• `Optional` **maxBodyLength**: `number`
+
+#### Inherited from
+
+Omit.maxBodyLength
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:84
+
+___
+
+### maxContentLength
+
+• `Optional` **maxContentLength**: `number`
+
+#### Inherited from
+
+Omit.maxContentLength
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:82
+
+___
+
+### maxRedirects
+
+• `Optional` **maxRedirects**: `number`
+
+#### Inherited from
+
+Omit.maxRedirects
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:85
+
+___
+
+### method
+
+• `Optional` **method**: [`Method`](../modules/internal.md#method)
+
+#### Inherited from
+
+Omit.method
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:64
+
+___
+
+### params
+
+• `Optional` **params**: `any`
+
+#### Inherited from
+
+Omit.params
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:69
+
+___
+
+### proxy
+
+• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md)
+
+#### Inherited from
+
+Omit.proxy
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:89
+
+___
+
+### raxConfig
+
+• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md)
+
+#### Inherited from
+
+Omit.raxConfig
+
+#### Defined in
+
+packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89
+
+___
+
+### responseType
+
+• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype)
+
+#### Inherited from
+
+Omit.responseType
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:77
+
+___
+
+### signal
+
+• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal)
+
+#### Inherited from
+
+Omit.signal
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:93
+
+___
+
+### socketPath
+
+• `Optional` **socketPath**: ``null`` \| `string`
+
+#### Inherited from
+
+Omit.socketPath
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:86
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `number`
+
+#### Inherited from
+
+Omit.timeout
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:72
+
+___
+
+### timeoutErrorMessage
+
+• `Optional` **timeoutErrorMessage**: `string`
+
+#### Inherited from
+
+Omit.timeoutErrorMessage
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:73
+
+___
+
+### transformRequest
+
+• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[]
+
+#### Inherited from
+
+Omit.transformRequest
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:66
+
+___
+
+### transformResponse
+
+• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[]
+
+#### Inherited from
+
+Omit.transformResponse
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:67
+
+___
+
+### transitional
+
+• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md)
+
+#### Inherited from
+
+Omit.transitional
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:92
+
+___
+
+### url
+
+• `Optional` **url**: `string`
+
+#### Inherited from
+
+Omit.url
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:63
+
+___
+
+### validateStatus
+
+• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean`
+
+#### Inherited from
+
+Omit.validateStatus
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:83
+
+___
+
+### withCredentials
+
+• `Optional` **withCredentials**: `boolean`
+
+#### Inherited from
+
+Omit.withCredentials
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:74
+
+___
+
+### xsrfCookieName
+
+• `Optional` **xsrfCookieName**: `string`
+
+#### Inherited from
+
+Omit.xsrfCookieName
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:78
+
+___
+
+### xsrfHeaderName
+
+• `Optional` **xsrfHeaderName**: `string`
+
+#### Inherited from
+
+Omit.xsrfHeaderName
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:79
+
+## Methods
+
+### onDownloadProgress
+
+▸ `Optional` **onDownloadProgress**(`progressEvent`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `progressEvent` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Omit.onDownloadProgress
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:81
+
+___
+
+### onUploadProgress
+
+▸ `Optional` **onUploadProgress**(`progressEvent`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `progressEvent` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Omit.onUploadProgress
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:80
+
+___
+
+### paramsSerializer
+
+▸ `Optional` **paramsSerializer**(`params`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+Omit.paramsSerializer
+
+#### Defined in
+
+packages/medusa-js/node_modules/axios/index.d.ts:70