docs: update docusaurus to v3 (#5625)
* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
This commit is contained in:
@@ -12,14 +12,14 @@ Finds tax providers and assists in tax related operations.
|
||||
|
||||
### constructor
|
||||
|
||||
**new TaxProviderService**(`container`)
|
||||
`**new TaxProviderService**(container)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "container",
|
||||
"type": "`AwilixContainer`<`any`\\>",
|
||||
"type": "AwilixContainer<any>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -33,7 +33,7 @@ Finds tax providers and assists in tax related operations.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "__configModule__",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -51,7 +51,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "__moduleDeclaration__",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -60,7 +60,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "cacheService_",
|
||||
"type": "[`ICacheService`](../interfaces/ICacheService.mdx)",
|
||||
"type": "[ICacheService](../interfaces/ICacheService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -69,7 +69,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "container_",
|
||||
"type": "`AwilixContainer`<`any`\\>",
|
||||
"type": "AwilixContainer<any>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -78,7 +78,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "eventBus_",
|
||||
"type": "[`IEventBusService`](../interfaces/IEventBusService.mdx)",
|
||||
"type": "[IEventBusService](../interfaces/IEventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -87,7 +87,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "manager_",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -96,7 +96,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "smTaxLineRepo_",
|
||||
"type": "`Repository`<[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)\\> & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines }",
|
||||
"type": "Repository<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -105,7 +105,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "taxLineRepo_",
|
||||
"type": "`Repository`<[`LineItemTaxLine`](LineItemTaxLine.mdx)\\> & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines }",
|
||||
"type": "Repository<[LineItemTaxLine](LineItemTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -114,7 +114,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "taxProviderRepo_",
|
||||
"type": "`Repository`<[`TaxProvider`](TaxProvider.mdx)\\>",
|
||||
"type": "Repository<[TaxProvider](TaxProvider.mdx)>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -123,7 +123,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "taxRateService_",
|
||||
"type": "[`TaxRateService`](TaxRateService.mdx)",
|
||||
"type": "[TaxRateService](TaxRateService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -132,7 +132,7 @@ Finds tax providers and assists in tax related operations.
|
||||
},
|
||||
{
|
||||
"name": "transactionManager_",
|
||||
"type": "`undefined` \\| `EntityManager`",
|
||||
"type": "`undefined` \\| EntityManager",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -145,16 +145,16 @@ Finds tax providers and assists in tax related operations.
|
||||
|
||||
### activeManager\_
|
||||
|
||||
`Protected` `get` **activeManager_**(): `EntityManager`
|
||||
`Protected get**activeManager_**(): EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
`EntityManager`
|
||||
EntityManager
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "EntityManager",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -167,7 +167,7 @@ Finds tax providers and assists in tax related operations.
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
|
||||
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter 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
|
||||
@@ -199,7 +199,7 @@ transaction manager is created.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "work",
|
||||
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
|
||||
"type": "(`transactionManager`: EntityManager) => Promise<TResult>",
|
||||
"description": "the transactional work to be done",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -208,7 +208,7 @@ transaction manager is created.
|
||||
},
|
||||
{
|
||||
"name": "isolationOrErrorHandler",
|
||||
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
|
||||
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise<void \\| TResult>",
|
||||
"description": "the isolation level to be used for the work.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -217,7 +217,7 @@ transaction manager is created.
|
||||
},
|
||||
{
|
||||
"name": "maybeErrorHandlerOrDontFail",
|
||||
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
|
||||
"type": "(`error`: `TError`) => Promise<void \\| TResult>",
|
||||
"description": "Potential error handler",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -228,12 +228,12 @@ transaction manager is created.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
Promise<TResult>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TResult`\\>",
|
||||
"type": "Promise<TResult>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of the transactional work",
|
||||
@@ -246,7 +246,7 @@ ___
|
||||
|
||||
### clearLineItemsTaxLines
|
||||
|
||||
**clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\>
|
||||
`**clearLineItemsTaxLines**(itemIds): Promise<void>`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -264,12 +264,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -282,7 +282,7 @@ ___
|
||||
|
||||
### clearTaxLines
|
||||
|
||||
**clearTaxLines**(`cartId`): `Promise`<`void`\>
|
||||
`**clearTaxLines**(cartId): Promise<void>`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -300,12 +300,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -318,7 +318,7 @@ ___
|
||||
|
||||
### createShippingTaxLines
|
||||
|
||||
**createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
`**createShippingTaxLines**(shippingMethod, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>`
|
||||
|
||||
Persists the tax lines relevant for a shipping method to the database. Used
|
||||
for return shipping methods.
|
||||
@@ -328,7 +328,7 @@ for return shipping methods.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "shippingMethod",
|
||||
"type": "[`ShippingMethod`](ShippingMethod.mdx)",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)",
|
||||
"description": "the shipping method to create tax lines for",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -337,7 +337,7 @@ for return shipping methods.
|
||||
},
|
||||
{
|
||||
"name": "calculationContext",
|
||||
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
|
||||
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
|
||||
"description": "the calculation context to get tax lines by",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -348,12 +348,12 @@ for return shipping methods.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \\| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\\>",
|
||||
"type": "Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the newly created tax lines",
|
||||
@@ -366,7 +366,7 @@ ___
|
||||
|
||||
### createTaxLines
|
||||
|
||||
**createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
`**createTaxLines**(cartOrLineItems, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>`
|
||||
|
||||
Persists the tax lines relevant for an order to the database.
|
||||
|
||||
@@ -375,7 +375,7 @@ Persists the tax lines relevant for an order to the database.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "cartOrLineItems",
|
||||
"type": "[`LineItem`](LineItem.mdx)[] \\| [`Cart`](Cart.mdx)",
|
||||
"type": "[LineItem](LineItem.mdx)[] \\| [Cart](Cart.mdx)",
|
||||
"description": "the cart or line items to create tax lines for",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -384,7 +384,7 @@ Persists the tax lines relevant for an order to the database.
|
||||
},
|
||||
{
|
||||
"name": "calculationContext",
|
||||
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
|
||||
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
|
||||
"description": "the calculation context to get tax lines by",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -395,12 +395,12 @@ Persists the tax lines relevant for an order to the database.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \\| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\\>",
|
||||
"type": "Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the newly created tax lines",
|
||||
@@ -413,7 +413,7 @@ ___
|
||||
|
||||
### getCacheKey
|
||||
|
||||
`Private` **getCacheKey**(`id`, `regionId`): `string`
|
||||
`Private **getCacheKey**(id, regionId): string`
|
||||
|
||||
The cache key to get cache hits by.
|
||||
|
||||
@@ -460,7 +460,7 @@ ___
|
||||
|
||||
### getRegionRatesForProduct
|
||||
|
||||
**getRegionRatesForProduct**(`productIds`, `region`): `Promise`<`Map`<`string`, [`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\>\>
|
||||
`**getRegionRatesForProduct**(productIds, region): Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]>>`
|
||||
|
||||
Gets the tax rates configured for a product. The rates are cached between
|
||||
calls.
|
||||
@@ -479,7 +479,7 @@ calls.
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[`RegionDetails`](../types/RegionDetails.mdx)",
|
||||
"type": "[RegionDetails](../types/RegionDetails.mdx)",
|
||||
"description": "the region to get configured rates for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -490,12 +490,12 @@ calls.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Map`<`string`, [`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\>\>
|
||||
Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]>>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`Map`<`string`, [`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\\>\\>",
|
||||
"type": "Promise<Map<string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]>>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the tax rates configured for the shipping option. A map by product id",
|
||||
@@ -508,7 +508,7 @@ ___
|
||||
|
||||
### getRegionRatesForShipping
|
||||
|
||||
**getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<[`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\>
|
||||
`**getRegionRatesForShipping**(optionId, regionDetails): Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]>`
|
||||
|
||||
Gets the tax rates configured for a shipping option. The rates are cached
|
||||
between calls.
|
||||
@@ -527,7 +527,7 @@ between calls.
|
||||
},
|
||||
{
|
||||
"name": "regionDetails",
|
||||
"type": "[`RegionDetails`](../types/RegionDetails.mdx)",
|
||||
"type": "[RegionDetails](../types/RegionDetails.mdx)",
|
||||
"description": "the region to get configured rates for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -538,12 +538,12 @@ between calls.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\>
|
||||
Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`TaxServiceRate`](../types/TaxServiceRate.mdx)[]\\>",
|
||||
"type": "Promise<[TaxServiceRate](../types/TaxServiceRate.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the tax rates configured for the shipping option.",
|
||||
@@ -556,7 +556,7 @@ ___
|
||||
|
||||
### getShippingTaxLines
|
||||
|
||||
**getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]\>
|
||||
`**getShippingTaxLines**(shippingMethod, calculationContext): Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]>`
|
||||
|
||||
Gets the relevant tax lines for a shipping method. Note: this method
|
||||
doesn't persist the tax lines. Use createShippingTaxLines if you wish to
|
||||
@@ -567,7 +567,7 @@ persist the tax lines to the DB layer.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "shippingMethod",
|
||||
"type": "[`ShippingMethod`](ShippingMethod.mdx)",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)",
|
||||
"description": "the shipping method to get tax lines for",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -576,7 +576,7 @@ persist the tax lines to the DB layer.
|
||||
},
|
||||
{
|
||||
"name": "calculationContext",
|
||||
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
|
||||
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
|
||||
"description": "the calculation context to get tax lines by",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -587,12 +587,12 @@ persist the tax lines to the DB layer.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]\>
|
||||
Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]\\>",
|
||||
"type": "Promise<[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the computed tax lines",
|
||||
@@ -605,7 +605,7 @@ ___
|
||||
|
||||
### getTaxLines
|
||||
|
||||
**getTaxLines**(`lineItems`, `calculationContext`): `Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
`**getTaxLines**(lineItems, calculationContext): Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>`
|
||||
|
||||
Gets the relevant tax lines for an order or cart. If an order is provided
|
||||
the order's tax lines will be returned. If a cart is provided the tax lines
|
||||
@@ -618,7 +618,7 @@ wish to persist the tax lines to the DB layer.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "lineItems",
|
||||
"type": "[`LineItem`](LineItem.mdx)[]",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"description": "the cart or order to get tax lines for",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -627,7 +627,7 @@ wish to persist the tax lines to the DB layer.
|
||||
},
|
||||
{
|
||||
"name": "calculationContext",
|
||||
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
|
||||
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
|
||||
"description": "the calculation context to get tax lines by",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -638,12 +638,12 @@ wish to persist the tax lines to the DB layer.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\>
|
||||
Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<([`LineItemTaxLine`](LineItemTaxLine.mdx) \\| [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx))[]\\>",
|
||||
"type": "Promise<([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the computed tax lines",
|
||||
@@ -656,7 +656,7 @@ ___
|
||||
|
||||
### getTaxLinesMap
|
||||
|
||||
`Protected` **getTaxLinesMap**(`items`, `calculationContext`): `Promise`<[`TaxLinesMaps`](../types/TaxLinesMaps.mdx)\>
|
||||
`Protected **getTaxLinesMap**(items, calculationContext): Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)>`
|
||||
|
||||
Return a map of tax lines for line items and shipping methods
|
||||
|
||||
@@ -665,7 +665,7 @@ Return a map of tax lines for line items and shipping methods
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[`LineItem`](LineItem.mdx)[]",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -674,7 +674,7 @@ Return a map of tax lines for line items and shipping methods
|
||||
},
|
||||
{
|
||||
"name": "calculationContext",
|
||||
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
|
||||
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -685,12 +685,12 @@ Return a map of tax lines for line items and shipping methods
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`TaxLinesMaps`](../types/TaxLinesMaps.mdx)\>
|
||||
Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`TaxLinesMaps`](../types/TaxLinesMaps.mdx)\\>",
|
||||
"type": "Promise<[TaxLinesMaps](../types/TaxLinesMaps.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -703,16 +703,16 @@ ___
|
||||
|
||||
### list
|
||||
|
||||
**list**(): `Promise`<[`TaxProvider`](TaxProvider.mdx)[]\>
|
||||
`**list**(): Promise<[TaxProvider](TaxProvider.mdx)[]>`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`TaxProvider`](TaxProvider.mdx)[]\>
|
||||
Promise<[TaxProvider](TaxProvider.mdx)[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`TaxProvider`](TaxProvider.mdx)[]\\>",
|
||||
"type": "Promise<[TaxProvider](TaxProvider.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -725,7 +725,7 @@ ___
|
||||
|
||||
### registerInstalledProviders
|
||||
|
||||
**registerInstalledProviders**(`providers`): `Promise`<`void`\>
|
||||
`**registerInstalledProviders**(providers): Promise<void>`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -743,12 +743,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -761,7 +761,7 @@ ___
|
||||
|
||||
### retrieveProvider
|
||||
|
||||
**retrieveProvider**(`region`): [`ITaxService`](../interfaces/ITaxService.mdx)
|
||||
`**retrieveProvider**(region): [ITaxService](../interfaces/ITaxService.mdx)`
|
||||
|
||||
Retrieves the relevant tax provider for the given region.
|
||||
|
||||
@@ -770,7 +770,7 @@ Retrieves the relevant tax provider for the given region.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[`Region`](Region.mdx)",
|
||||
"type": "[Region](Region.mdx)",
|
||||
"description": "the region to get tax provider for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -781,12 +781,12 @@ Retrieves the relevant tax provider for the given region.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ITaxService`](../interfaces/ITaxService.mdx)
|
||||
[ITaxService](../interfaces/ITaxService.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "getTaxLines",
|
||||
"type": "(`itemLines`: [`ItemTaxCalculationLine`](../types/ItemTaxCalculationLine.mdx)[], `shippingLines`: [`ShippingTaxCalculationLine`](../types/ShippingTaxCalculationLine.mdx)[], `context`: [`TaxCalculationContext`](../types/TaxCalculationContext.mdx)) => `Promise`<[`ProviderTaxLine`](../types/ProviderTaxLine.mdx)[]\\>",
|
||||
"type": "(`itemLines`: [ItemTaxCalculationLine](../types/ItemTaxCalculationLine.mdx)[], `shippingLines`: [ShippingTaxCalculationLine](../types/ShippingTaxCalculationLine.mdx)[], `context`: [TaxCalculationContext](../types/TaxCalculationContext.mdx)) => Promise<[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -799,14 +799,14 @@ ___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "err",
|
||||
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
|
||||
"type": "`Record<string, unknown>` \\| `{ code: string }`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -835,14 +835,14 @@ ___
|
||||
|
||||
### withTransaction
|
||||
|
||||
**withTransaction**(`transactionManager?`): [`TaxProviderService`](TaxProviderService.mdx)
|
||||
`**withTransaction**(transactionManager?): [TaxProviderService](TaxProviderService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -853,12 +853,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
[`TaxProviderService`](TaxProviderService.mdx)
|
||||
[TaxProviderService](TaxProviderService.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TaxProviderService",
|
||||
"type": "[`TaxProviderService`](TaxProviderService.mdx)",
|
||||
"type": "[TaxProviderService](TaxProviderService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
Reference in New Issue
Block a user