asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
docs/content/references/services/classes/CustomShippingOptionService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService<CustomShippingOptionService\>.constructor
#### Defined in
[services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L19)
[packages/medusa/src/services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L19)
## Properties
@@ -36,6 +36,10 @@ TransactionBaseService<CustomShippingOptionService\>.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +50,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### customShippingOptionRepository\_
@@ -54,7 +62,7 @@ ___
#### Defined in
[services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L17)
[packages/medusa/src/services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L17)
___
@@ -68,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L15)
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L15)
___
@@ -82,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L16)
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L16)
## Methods
@@ -90,6 +98,10 @@ TransactionBaseService.transactionManager\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -101,21 +113,23 @@ TransactionBaseService.transactionManager\_
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -123,19 +137,23 @@ ___
▸ **create**(`data`): `Promise`<`CustomShippingOption`\>
Creates a custom shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateCustomShippingOptionInput` | |
| `data` | `CreateCustomShippingOptionInput` | the custom shipping option to create |
#### Returns
`Promise`<`CustomShippingOption`\>
resolves to the creation result
#### Defined in
[services/custom-shipping-option.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L90)
[packages/medusa/src/services/custom-shipping-option.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L88)
___
@@ -143,20 +161,24 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`CustomShippingOption`[]\>
Fetches all custom shipping options based on the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`CustomShippingOption`\> | |
| `config` | `FindConfig`<`CustomShippingOption`\> | |
| `selector` | `Selector`<`CustomShippingOption`\> | the query object for find |
| `config` | `FindConfig`<`CustomShippingOption`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`CustomShippingOption`[]\>
custom shipping options matching the query
#### Defined in
[services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L65)
[packages/medusa/src/services/custom-shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L64)
___
@@ -164,20 +186,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`CustomShippingOption`\>
Retrieves a specific shipping option.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`CustomShippingOption`\> | |
| `id` | `string` | the id of the custom shipping option to retrieve. |
| `config` | `FindConfig`<`CustomShippingOption`\> | any options needed to query for the result. |
#### Returns
`Promise`<`CustomShippingOption`\>
the requested custom shipping option.
#### Defined in
[services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L36)
[packages/medusa/src/services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L36)
___
@@ -201,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -225,4 +251,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)