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

docs: update override price selection strategy documentation (#5438)

Browse Source 
* docs: update override price selection strategy documentation

* fix eslint errors
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-10-20 20:17:45 +03:00
1 parent 8bc902fb0f
commit 1a10822cae
540 files changed
+244366 -18865
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### valueOf
▸ **valueOf**(): `boolean`
**valueOf**(): `boolean`
Returns the primitive value of the specified object.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx
+4 -4
View File
@@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\>
**[asyncIterator]**(): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\>
#### Returns
@@ -62,7 +62,7 @@ ___
### next
▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
@@ -109,7 +109,7 @@ ___
### return
▸ **return**(`value`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
**return**(`value`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
@@ -156,7 +156,7 @@ ___
### throw
▸ **throw**(`e`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
**throw**(`e`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AsyncGeneratorFunction
▸ **AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\>
**AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\>
Creates a new AsyncGenerator object.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\>
**[asyncIterator]**(): [`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\>
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx
+4 -4
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\>
**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\>
#### Returns
@@ -46,7 +46,7 @@ ___
### next
▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
#### Parameters
@@ -102,7 +102,7 @@ ___
### return
▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
`Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
#### Parameters
@@ -158,7 +158,7 @@ ___
### throw
▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
`Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx
+3 -3
View File
@@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### next
▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
@@ -84,7 +84,7 @@ ___
### return
▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
`Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
@@ -127,7 +127,7 @@ ___
### throw
▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
`Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx
+104 -104
View File
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [iterator]
▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
**[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
#### Returns
@@ -99,7 +99,7 @@ ___
### at
▸ **at**(`index`): `undefined` \| `number`
**at**(`index`): `undefined` \| `number`
Takes an integer value and returns the item at that index,
allowing for positive and negative integers.
@@ -141,7 +141,7 @@ ___
### compare
▸ **compare**(`target`, `targetStart?`, `targetEnd?`, `sourceStart?`, `sourceEnd?`): ``0`` \| ``1`` \| ``-1``
**compare**(`target`, `targetStart?`, `targetEnd?`, `sourceStart?`, `sourceEnd?`): ``0`` \| ``1`` \| ``-1``
Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order.
Comparison is based on the actual sequence of bytes in each `Buffer`.
@@ -258,7 +258,7 @@ ___
### copy
▸ **copy**(`target`, `targetStart?`, `sourceStart?`, `sourceEnd?`): `number`
**copy**(`target`, `targetStart?`, `sourceStart?`, `sourceEnd?`): `number`
Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`.
@@ -366,7 +366,7 @@ ___
### copyWithin
▸ **copyWithin**(`target`, `start`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**copyWithin**(`target`, `start`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Returns the this object after copying a section of the array identified by start and end
to the same array starting at position target
@@ -423,7 +423,7 @@ ___
### entries
▸ **entries**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<[`number`, `number`]\>
**entries**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<[`number`, `number`]\>
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents
of `buf`.
@@ -491,7 +491,7 @@ ___
### equals
▸ **equals**(`otherBuffer`): `boolean`
**equals**(`otherBuffer`): `boolean`
Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`.
@@ -544,7 +544,7 @@ ___
### every
▸ **every**(`predicate`, `thisArg?`): `boolean`
**every**(`predicate`, `thisArg?`): `boolean`
Determines whether all the members of an array satisfy the specified test.
@@ -592,7 +592,7 @@ ___
### fill
▸ **fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
the entire `buf` will be filled:
@@ -710,7 +710,7 @@ ___
### filter
▸ **filter**(`predicate`, `thisArg?`): `Uint8Array`
**filter**(`predicate`, `thisArg?`): `Uint8Array`
Returns the elements of an array that meet the condition specified in a callback function.
@@ -758,7 +758,7 @@ ___
### find
▸ **find**(`predicate`, `thisArg?`): `undefined` \| `number`
**find**(`predicate`, `thisArg?`): `undefined` \| `number`
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
@@ -807,7 +807,7 @@ ___
### findIndex
▸ **findIndex**(`predicate`, `thisArg?`): `number`
**findIndex**(`predicate`, `thisArg?`): `number`
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
@@ -856,7 +856,7 @@ ___
### forEach
▸ **forEach**(`callbackfn`, `thisArg?`): `void`
**forEach**(`callbackfn`, `thisArg?`): `void`
Performs the specified action for each element in an array.
@@ -904,7 +904,7 @@ ___
### includes
▸ **includes**(`value`, `byteOffset?`, `encoding?`): `boolean`
**includes**(`value`, `byteOffset?`, `encoding?`): `boolean`
Equivalent to `buf.indexOf() !== -1`.
@@ -985,7 +985,7 @@ ___
### indexOf
▸ **indexOf**(`value`, `byteOffset?`, `encoding?`): `number`
**indexOf**(`value`, `byteOffset?`, `encoding?`): `number`
If `value` is:
@@ -1105,7 +1105,7 @@ ___
### join
▸ **join**(`separator?`): `string`
**join**(`separator?`): `string`
Adds all the elements of an array separated by the specified separator string.
@@ -1145,7 +1145,7 @@ ___
### keys
▸ **keys**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
**keys**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices).
@@ -1202,7 +1202,7 @@ ___
### lastIndexOf
▸ **lastIndexOf**(`value`, `byteOffset?`, `encoding?`): `number`
**lastIndexOf**(`value`, `byteOffset?`, `encoding?`): `number`
Identical to `buf.indexOf()`, except the last occurrence of `value` is found
rather than the first occurrence.
@@ -1321,7 +1321,7 @@ ___
### map
▸ **map**(`callbackfn`, `thisArg?`): `Uint8Array`
**map**(`callbackfn`, `thisArg?`): `Uint8Array`
Calls a defined callback function on each element of an array, and returns an array that
contains the results.
@@ -1370,7 +1370,7 @@ ___
### readBigInt64BE
▸ **readBigInt64BE**(`offset?`): `bigint`
**readBigInt64BE**(`offset?`): `bigint`
Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`.
@@ -1413,7 +1413,7 @@ ___
### readBigInt64LE
▸ **readBigInt64LE**(`offset?`): `bigint`
**readBigInt64LE**(`offset?`): `bigint`
Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`.
@@ -1456,7 +1456,7 @@ ___
### readBigUInt64BE
▸ **readBigUInt64BE**(`offset?`): `bigint`
**readBigUInt64BE**(`offset?`): `bigint`
Reads an unsigned, big-endian 64-bit integer from `buf` at the specified`offset`.
@@ -1507,7 +1507,7 @@ ___
### readBigUInt64LE
▸ **readBigUInt64LE**(`offset?`): `bigint`
**readBigUInt64LE**(`offset?`): `bigint`
Reads an unsigned, little-endian 64-bit integer from `buf` at the specified`offset`.
@@ -1558,7 +1558,7 @@ ___
### readBigUint64BE
▸ **readBigUint64BE**(`offset?`): `bigint`
**readBigUint64BE**(`offset?`): `bigint`
#### Parameters
@@ -1600,7 +1600,7 @@ ___
### readBigUint64LE
▸ **readBigUint64LE**(`offset?`): `bigint`
**readBigUint64LE**(`offset?`): `bigint`
#### Parameters
@@ -1642,7 +1642,7 @@ ___
### readDoubleBE
▸ **readDoubleBE**(`offset?`): `number`
**readDoubleBE**(`offset?`): `number`
Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
@@ -1691,7 +1691,7 @@ ___
### readDoubleLE
▸ **readDoubleLE**(`offset?`): `number`
**readDoubleLE**(`offset?`): `number`
Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
@@ -1742,7 +1742,7 @@ ___
### readFloatBE
▸ **readFloatBE**(`offset?`): `number`
**readFloatBE**(`offset?`): `number`
Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
@@ -1791,7 +1791,7 @@ ___
### readFloatLE
▸ **readFloatLE**(`offset?`): `number`
**readFloatLE**(`offset?`): `number`
Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
@@ -1842,7 +1842,7 @@ ___
### readInt16BE
▸ **readInt16BE**(`offset?`): `number`
**readInt16BE**(`offset?`): `number`
Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`.
@@ -1893,7 +1893,7 @@ ___
### readInt16LE
▸ **readInt16LE**(`offset?`): `number`
**readInt16LE**(`offset?`): `number`
Reads a signed, little-endian 16-bit integer from `buf` at the specified`offset`.
@@ -1946,7 +1946,7 @@ ___
### readInt32BE
▸ **readInt32BE**(`offset?`): `number`
**readInt32BE**(`offset?`): `number`
Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`.
@@ -1997,7 +1997,7 @@ ___
### readInt32LE
▸ **readInt32LE**(`offset?`): `number`
**readInt32LE**(`offset?`): `number`
Reads a signed, little-endian 32-bit integer from `buf` at the specified`offset`.
@@ -2050,7 +2050,7 @@ ___
### readInt8
▸ **readInt8**(`offset?`): `number`
**readInt8**(`offset?`): `number`
Reads a signed 8-bit integer from `buf` at the specified `offset`.
@@ -2105,7 +2105,7 @@ ___
### readIntBE
▸ **readIntBE**(`offset`, `byteLength`): `number`
**readIntBE**(`offset`, `byteLength`): `number`
Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
@@ -2167,7 +2167,7 @@ ___
### readIntLE
▸ **readIntLE**(`offset`, `byteLength`): `number`
**readIntLE**(`offset`, `byteLength`): `number`
Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
@@ -2225,7 +2225,7 @@ ___
### readUInt16BE
▸ **readUInt16BE**(`offset?`): `number`
**readUInt16BE**(`offset?`): `number`
Reads an unsigned, big-endian 16-bit integer from `buf` at the specified`offset`.
@@ -2278,7 +2278,7 @@ ___
### readUInt16LE
▸ **readUInt16LE**(`offset?`): `number`
**readUInt16LE**(`offset?`): `number`
Reads an unsigned, little-endian 16-bit integer from `buf` at the specified`offset`.
@@ -2333,7 +2333,7 @@ ___
### readUInt32BE
▸ **readUInt32BE**(`offset?`): `number`
**readUInt32BE**(`offset?`): `number`
Reads an unsigned, big-endian 32-bit integer from `buf` at the specified`offset`.
@@ -2384,7 +2384,7 @@ ___
### readUInt32LE
▸ **readUInt32LE**(`offset?`): `number`
**readUInt32LE**(`offset?`): `number`
Reads an unsigned, little-endian 32-bit integer from `buf` at the specified`offset`.
@@ -2437,7 +2437,7 @@ ___
### readUInt8
▸ **readUInt8**(`offset?`): `number`
**readUInt8**(`offset?`): `number`
Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
@@ -2492,7 +2492,7 @@ ___
### readUIntBE
▸ **readUIntBE**(`offset`, `byteLength`): `number`
**readUIntBE**(`offset`, `byteLength`): `number`
Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned big-endian integer supporting
up to 48 bits of accuracy.
@@ -2554,7 +2554,7 @@ ___
### readUIntLE
▸ **readUIntLE**(`offset`, `byteLength`): `number`
**readUIntLE**(`offset`, `byteLength`): `number`
Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned, little-endian integer supporting
up to 48 bits of accuracy.
@@ -2614,7 +2614,7 @@ ___
### readUint16BE
▸ **readUint16BE**(`offset?`): `number`
**readUint16BE**(`offset?`): `number`
#### Parameters
@@ -2656,7 +2656,7 @@ ___
### readUint16LE
▸ **readUint16LE**(`offset?`): `number`
**readUint16LE**(`offset?`): `number`
#### Parameters
@@ -2698,7 +2698,7 @@ ___
### readUint32BE
▸ **readUint32BE**(`offset?`): `number`
**readUint32BE**(`offset?`): `number`
#### Parameters
@@ -2740,7 +2740,7 @@ ___
### readUint32LE
▸ **readUint32LE**(`offset?`): `number`
**readUint32LE**(`offset?`): `number`
#### Parameters
@@ -2782,7 +2782,7 @@ ___
### readUint8
▸ **readUint8**(`offset?`): `number`
**readUint8**(`offset?`): `number`
#### Parameters
@@ -2824,7 +2824,7 @@ ___
### readUintBE
▸ **readUintBE**(`offset`, `byteLength`): `number`
**readUintBE**(`offset`, `byteLength`): `number`
#### Parameters
@@ -2874,7 +2874,7 @@ ___
### readUintLE
▸ **readUintLE**(`offset`, `byteLength`): `number`
**readUintLE**(`offset`, `byteLength`): `number`
#### Parameters
@@ -2924,7 +2924,7 @@ ___
### reduce
▸ **reduce**(`callbackfn`): `number`
**reduce**(`callbackfn`): `number`
Calls the specified callback function for all the elements in an array. The return value of
the callback function is the accumulated result, and is provided as an argument in the next
@@ -2962,7 +2962,7 @@ call to the callback function.
Uint8Array.reduce
▸ **reduce**(`callbackfn`, `initialValue`): `number`
**reduce**(`callbackfn`, `initialValue`): `number`
#### Parameters
@@ -3004,7 +3004,7 @@ Uint8Array.reduce
Uint8Array.reduce
▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U`
**reduce**<`U`\>(`callbackfn`, `initialValue`): `U`
Calls the specified callback function for all the elements in an array. The return value of
the callback function is the accumulated result, and is provided as an argument in the next
@@ -3056,7 +3056,7 @@ ___
### reduceRight
▸ **reduceRight**(`callbackfn`): `number`
**reduceRight**(`callbackfn`): `number`
Calls the specified callback function for all the elements in an array, in descending order.
The return value of the callback function is the accumulated result, and is provided as an
@@ -3094,7 +3094,7 @@ argument in the next call to the callback function.
Uint8Array.reduceRight
▸ **reduceRight**(`callbackfn`, `initialValue`): `number`
**reduceRight**(`callbackfn`, `initialValue`): `number`
#### Parameters
@@ -3136,7 +3136,7 @@ Uint8Array.reduceRight
Uint8Array.reduceRight
▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U`
**reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U`
Calls the specified callback function for all the elements in an array, in descending order.
The return value of the callback function is the accumulated result, and is provided as an
@@ -3188,7 +3188,7 @@ ___
### reverse
▸ **reverse**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**reverse**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
#### Returns
@@ -3213,7 +3213,7 @@ ___
### set
▸ **set**(`array`, `offset?`): `void`
**set**(`array`, `offset?`): `void`
Sets a value or an array of values.
@@ -3261,7 +3261,7 @@ ___
### slice
▸ **slice**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**slice**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Returns a new `Buffer` that references the same memory as the original, but
offset and cropped by the `start` and `end` indices.
@@ -3343,7 +3343,7 @@ ___
### some
▸ **some**(`predicate`, `thisArg?`): `boolean`
**some**(`predicate`, `thisArg?`): `boolean`
Determines whether the specified callback function returns true for any element of an array.
@@ -3391,7 +3391,7 @@ ___
### sort
▸ **sort**(`compareFn?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**sort**(`compareFn?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Sorts an array.
@@ -3431,7 +3431,7 @@ ___
### subarray
▸ **subarray**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**subarray**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Returns a new `Buffer` that references the same memory as the original, but
offset and cropped by the `start` and `end` indices.
@@ -3536,7 +3536,7 @@ ___
### swap16
▸ **swap16**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**swap16**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Interprets `buf` as an array of unsigned 16-bit integers and swaps the
byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2.
@@ -3593,7 +3593,7 @@ ___
### swap32
▸ **swap32**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**swap32**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Interprets `buf` as an array of unsigned 32-bit integers and swaps the
byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
@@ -3640,7 +3640,7 @@ ___
### swap64
▸ **swap64**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**swap64**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8.
@@ -3687,7 +3687,7 @@ ___
### toJSON
▸ **toJSON**(): { `data`: `number`[] ; `type`: ``"Buffer"`` }
**toJSON**(): { `data`: `number`[] ; `type`: ``"Buffer"`` }
Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls
this function when stringifying a `Buffer` instance.
@@ -3756,7 +3756,7 @@ ___
### toLocaleString
▸ **toLocaleString**(): `string`
**toLocaleString**(): `string`
Converts a number to a string by using the current locale.
@@ -3783,7 +3783,7 @@ ___
### toString
▸ **toString**(`encoding?`, `start?`, `end?`): `string`
**toString**(`encoding?`, `start?`, `end?`): `string`
Decodes `buf` to a string according to the specified character encoding in`encoding`. `start` and `end` may be passed to decode only a subset of `buf`.
@@ -3874,7 +3874,7 @@ ___
### valueOf
▸ **valueOf**(): `Uint8Array`
**valueOf**(): `Uint8Array`
Returns the primitive value of the specified object.
@@ -3901,7 +3901,7 @@ ___
### values
▸ **values**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
**values**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\>
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is
called automatically when a `Buffer` is used in a `for..of` statement.
@@ -3970,7 +3970,7 @@ ___
### write
▸ **write**(`string`, `encoding?`): `number`
**write**(`string`, `encoding?`): `number`
Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did
not contain enough space to fit the entire string, only part of `string` will be
@@ -4034,7 +4034,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
v0.1.90
▸ **write**(`string`, `offset`, `encoding?`): `number`
**write**(`string`, `offset`, `encoding?`): `number`
#### Parameters
@@ -4080,7 +4080,7 @@ v0.1.90
}
]} />
▸ **write**(`string`, `offset`, `length`, `encoding?`): `number`
**write**(`string`, `offset`, `length`, `encoding?`): `number`
#### Parameters
@@ -4138,7 +4138,7 @@ ___
### writeBigInt64BE
▸ **writeBigInt64BE**(`value`, `offset?`): `number`
**writeBigInt64BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian.
@@ -4199,7 +4199,7 @@ ___
### writeBigInt64LE
▸ **writeBigInt64LE**(`value`, `offset?`): `number`
**writeBigInt64LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian.
@@ -4260,7 +4260,7 @@ ___
### writeBigUInt64BE
▸ **writeBigUInt64BE**(`value`, `offset?`): `number`
**writeBigUInt64BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian.
@@ -4321,7 +4321,7 @@ ___
### writeBigUInt64LE
▸ **writeBigUInt64LE**(`value`, `offset?`): `number`
**writeBigUInt64LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian
@@ -4382,7 +4382,7 @@ ___
### writeBigUint64BE
▸ **writeBigUint64BE**(`value`, `offset?`): `number`
**writeBigUint64BE**(`value`, `offset?`): `number`
#### Parameters
@@ -4432,7 +4432,7 @@ ___
### writeBigUint64LE
▸ **writeBigUint64LE**(`value`, `offset?`): `number`
**writeBigUint64LE**(`value`, `offset?`): `number`
#### Parameters
@@ -4482,7 +4482,7 @@ ___
### writeDoubleBE
▸ **writeDoubleBE**(`value`, `offset?`): `number`
**writeDoubleBE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
@@ -4542,7 +4542,7 @@ ___
### writeDoubleLE
▸ **writeDoubleLE**(`value`, `offset?`): `number`
**writeDoubleLE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything
other than a JavaScript number.
@@ -4602,7 +4602,7 @@ ___
### writeFloatBE
▸ **writeFloatBE**(`value`, `offset?`): `number`
**writeFloatBE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
@@ -4662,7 +4662,7 @@ ___
### writeFloatLE
▸ **writeFloatLE**(`value`, `offset?`): `number`
**writeFloatLE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is
undefined when `value` is anything other than a JavaScript number.
@@ -4722,7 +4722,7 @@ ___
### writeInt16BE
▸ **writeInt16BE**(`value`, `offset?`): `number`
**writeInt16BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is
anything other than a signed 16-bit integer.
@@ -4784,7 +4784,7 @@ ___
### writeInt16LE
▸ **writeInt16LE**(`value`, `offset?`): `number`
**writeInt16LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is
anything other than a signed 16-bit integer.
@@ -4846,7 +4846,7 @@ ___
### writeInt32BE
▸ **writeInt32BE**(`value`, `offset?`): `number`
**writeInt32BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is
anything other than a signed 32-bit integer.
@@ -4908,7 +4908,7 @@ ___
### writeInt32LE
▸ **writeInt32LE**(`value`, `offset?`): `number`
**writeInt32LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is
anything other than a signed 32-bit integer.
@@ -4970,7 +4970,7 @@ ___
### writeInt8
▸ **writeInt8**(`value`, `offset?`): `number`
**writeInt8**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset`. `value` must be a valid
signed 8-bit integer. Behavior is undefined when `value` is anything other than
@@ -5034,7 +5034,7 @@ ___
### writeIntBE
▸ **writeIntBE**(`value`, `offset`, `byteLength`): `number`
**writeIntBE**(`value`, `offset`, `byteLength`): `number`
Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when`value` is anything other than a
signed integer.
@@ -5102,7 +5102,7 @@ ___
### writeIntLE
▸ **writeIntLE**(`value`, `offset`, `byteLength`): `number`
**writeIntLE**(`value`, `offset`, `byteLength`): `number`
Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than a signed integer.
@@ -5170,7 +5170,7 @@ ___
### writeUInt16BE
▸ **writeUInt16BE**(`value`, `offset?`): `number`
**writeUInt16BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value`is anything other than an
unsigned 16-bit integer.
@@ -5233,7 +5233,7 @@ ___
### writeUInt16LE
▸ **writeUInt16LE**(`value`, `offset?`): `number`
**writeUInt16LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is
anything other than an unsigned 16-bit integer.
@@ -5296,7 +5296,7 @@ ___
### writeUInt32BE
▸ **writeUInt32BE**(`value`, `offset?`): `number`
**writeUInt32BE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value`is anything other than an
unsigned 32-bit integer.
@@ -5358,7 +5358,7 @@ ___
### writeUInt32LE
▸ **writeUInt32LE**(`value`, `offset?`): `number`
**writeUInt32LE**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is
anything other than an unsigned 32-bit integer.
@@ -5420,7 +5420,7 @@ ___
### writeUInt8
▸ **writeUInt8**(`value`, `offset?`): `number`
**writeUInt8**(`value`, `offset?`): `number`
Writes `value` to `buf` at the specified `offset`. `value` must be a
valid unsigned 8-bit integer. Behavior is undefined when `value` is anything
@@ -5486,7 +5486,7 @@ ___
### writeUIntBE
▸ **writeUIntBE**(`value`, `offset`, `byteLength`): `number`
**writeUIntBE**(`value`, `offset`, `byteLength`): `number`
Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than an unsigned integer.
@@ -5556,7 +5556,7 @@ ___
### writeUIntLE
▸ **writeUIntLE**(`value`, `offset`, `byteLength`): `number`
**writeUIntLE**(`value`, `offset`, `byteLength`): `number`
Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than an unsigned integer.
@@ -5626,7 +5626,7 @@ ___
### writeUint16BE
▸ **writeUint16BE**(`value`, `offset?`): `number`
**writeUint16BE**(`value`, `offset?`): `number`
#### Parameters
@@ -5676,7 +5676,7 @@ ___
### writeUint16LE
▸ **writeUint16LE**(`value`, `offset?`): `number`
**writeUint16LE**(`value`, `offset?`): `number`
#### Parameters
@@ -5726,7 +5726,7 @@ ___
### writeUint32BE
▸ **writeUint32BE**(`value`, `offset?`): `number`
**writeUint32BE**(`value`, `offset?`): `number`
#### Parameters
@@ -5776,7 +5776,7 @@ ___
### writeUint32LE
▸ **writeUint32LE**(`value`, `offset?`): `number`
**writeUint32LE**(`value`, `offset?`): `number`
#### Parameters
@@ -5826,7 +5826,7 @@ ___
### writeUint8
▸ **writeUint8**(`value`, `offset?`): `number`
**writeUint8**(`value`, `offset?`): `number`
#### Parameters
@@ -5876,7 +5876,7 @@ ___
### writeUintBE
▸ **writeUintBE**(`value`, `offset`, `byteLength`): `number`
**writeUintBE**(`value`, `offset`, `byteLength`): `number`
#### Parameters
@@ -5934,7 +5934,7 @@ ___
### writeUintLE
▸ **writeUintLE**(`value`, `offset`, `byteLength`): `number`
**writeUintLE**(`value`, `offset`, `byteLength`): `number`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx
+14 -14
View File
@@ -29,7 +29,7 @@ Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'bas
### alloc
▸ **alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled.
@@ -125,7 +125,7 @@ ___
### allocUnsafe
▸ **allocUnsafe**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**allocUnsafe**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown.
@@ -195,7 +195,7 @@ ___
### allocUnsafeSlow
▸ **allocUnsafeSlow**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**allocUnsafeSlow**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. A zero-length `Buffer` is created if
`size` is 0.
@@ -274,7 +274,7 @@ ___
### byteLength
▸ **byteLength**(`string`, `encoding?`): `number`
**byteLength**(`string`, `encoding?`): `number`
Returns the byte length of a string when encoded using `encoding`.
This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account
@@ -344,7 +344,7 @@ ___
### compare
▸ **compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1``
**compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1``
Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
@@ -404,7 +404,7 @@ ___
### concat
▸ **concat**(`list`, `totalLength?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**concat**(`list`, `totalLength?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
@@ -484,7 +484,7 @@ ___
### copyBytesFrom
▸ **copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Copies the underlying memory of `view` into a new `Buffer`.
@@ -549,7 +549,7 @@ ___
### from
▸ **from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
Array entries outside that range will be truncated to fit into it.
@@ -618,7 +618,7 @@ appropriate for `Buffer.from()` variants.
v5.10.0
▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Creates a new Buffer using the passed {data}
@@ -650,7 +650,7 @@ Creates a new Buffer using the passed {data}
}
]} />
▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
#### Parameters
@@ -680,7 +680,7 @@ Creates a new Buffer using the passed {data}
}
]} />
▸ **from**(`str`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**from**(`str`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Creates a new Buffer containing the given JavaScript string {str}.
If provided, the {encoding} parameter identifies the character encoding.
@@ -726,7 +726,7 @@ ___
### isBuffer
▸ **isBuffer**(`obj`): obj is Buffer
**isBuffer**(`obj`): obj is Buffer
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
@@ -776,7 +776,7 @@ ___
### isEncoding
▸ **isEncoding**(`encoding`): encoding is BufferEncoding
**isEncoding**(`encoding`): encoding is BufferEncoding
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
@@ -833,7 +833,7 @@ ___
### of
▸ **of**(`...items`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**of**(`...items`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
Creates a new Buffer using the passed {data}
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx
+13 -13
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### getColumnNumber
▸ **getColumnNumber**(): ``null`` \| `number`
**getColumnNumber**(): ``null`` \| `number`
Current column number [if this function was defined in a script]
@@ -35,7 +35,7 @@ ___
### getEvalOrigin
▸ **getEvalOrigin**(): `undefined` \| `string`
**getEvalOrigin**(): `undefined` \| `string`
A call site object representing the location where eval was called
[if this function was created using a call to eval]
@@ -59,7 +59,7 @@ ___
### getFileName
▸ **getFileName**(): `undefined` \| `string`
**getFileName**(): `undefined` \| `string`
Name of the script [if this function was defined in a script]
@@ -82,7 +82,7 @@ ___
### getFunction
▸ **getFunction**(): `undefined` \| `Function`
**getFunction**(): `undefined` \| `Function`
Current function
@@ -105,7 +105,7 @@ ___
### getFunctionName
▸ **getFunctionName**(): ``null`` \| `string`
**getFunctionName**(): ``null`` \| `string`
Name of the current function, typically its name property.
If a name property is not available an attempt will be made to try
@@ -130,7 +130,7 @@ ___
### getLineNumber
▸ **getLineNumber**(): ``null`` \| `number`
**getLineNumber**(): ``null`` \| `number`
Current line number [if this function was defined in a script]
@@ -153,7 +153,7 @@ ___
### getMethodName
▸ **getMethodName**(): ``null`` \| `string`
**getMethodName**(): ``null`` \| `string`
Name of the property [of "this" or one of its prototypes] that holds
the current function
@@ -177,7 +177,7 @@ ___
### getThis
▸ **getThis**(): `unknown`
**getThis**(): `unknown`
Value of "this"
@@ -200,7 +200,7 @@ ___
### getTypeName
▸ **getTypeName**(): ``null`` \| `string`
**getTypeName**(): ``null`` \| `string`
Type of "this" as a string.
This is the name of the function stored in the constructor field of
@@ -226,7 +226,7 @@ ___
### isConstructor
▸ **isConstructor**(): `boolean`
**isConstructor**(): `boolean`
Is this a constructor call?
@@ -249,7 +249,7 @@ ___
### isEval
▸ **isEval**(): `boolean`
**isEval**(): `boolean`
Does this call take place in code defined by a call to eval?
@@ -272,7 +272,7 @@ ___
### isNative
▸ **isNative**(): `boolean`
**isNative**(): `boolean`
Is this call in native V8 code?
@@ -295,7 +295,7 @@ ___
### isToplevel
▸ **isToplevel**(): `boolean`
**isToplevel**(): `boolean`
Is this a toplevel invocation, that is, is "this" the global object?
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx
+6 -6
View File
@@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
`Optional` **construct**(`this`, `callback`): `void`
#### Parameters
@@ -175,7 +175,7 @@ ___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
`Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
@@ -229,7 +229,7 @@ ___
### final
▸ `Optional` **final**(`this`, `callback`): `void`
`Optional` **final**(`this`, `callback`): `void`
#### Parameters
@@ -275,7 +275,7 @@ ___
### read
▸ `Optional` **read**(`this`, `size`): `void`
`Optional` **read**(`this`, `size`): `void`
#### Parameters
@@ -321,7 +321,7 @@ ___
### write
▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -383,7 +383,7 @@ ___
### writev
▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void`
`Optional` **writev**(`this`, `chunks`, `callback`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx
+15 -15
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addListener
▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -60,7 +60,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -144,7 +144,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -195,7 +195,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
@@ -223,7 +223,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -273,7 +273,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -321,7 +321,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Alias for `emitter.removeListener()`.
@@ -369,7 +369,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -442,7 +442,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -513,7 +513,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -572,7 +572,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -629,7 +629,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -695,7 +695,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -741,7 +741,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -867,7 +867,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
**setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### get
▸ **get**<`T`\>(`key`): `Promise`<``null`` \| `T`\>
**get**<`T`\>(`key`): `Promise`<``null`` \| `T`\>
<ParameterTypes parameters={[
{
@@ -66,7 +66,7 @@ ___
### invalidate
▸ **invalidate**(`key`): `Promise`<`void`\>
**invalidate**(`key`): `Promise`<`void`\>
#### Parameters
@@ -100,7 +100,7 @@ ___
### set
▸ **set**(`key`, `data`, `ttl?`): `Promise`<`void`\>
**set**(`key`, `data`, `ttl?`): `Promise`<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx
+4 -4
View File
@@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\>
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\>
<ParameterTypes parameters={[
{
@@ -73,7 +73,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **emit**<`T`\>(`data`): `Promise`<`void`\>
**emit**<`T`\>(`data`): `Promise`<`void`\>
<ParameterTypes parameters={[
{
@@ -118,7 +118,7 @@ ___
### subscribe
▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx)
**subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx)
#### Parameters
@@ -168,7 +168,7 @@ ___
### unsubscribe
▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx)
**unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusService.mdx
+4 -4
View File
@@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
▸ **emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\>
**emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\>
<ParameterTypes parameters={[
{
@@ -86,7 +86,7 @@ ___
### subscribe
▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
**subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
#### Parameters
@@ -136,7 +136,7 @@ ___
### unsubscribe
▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
**unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
#### Parameters
@@ -186,7 +186,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
**withTransaction**(`transactionManager?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx
+29 -29
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_joinerConfig
▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
**__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
#### Returns
@@ -33,7 +33,7 @@ ___
### adjustInventory
▸ **adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
**adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
#### Parameters
@@ -100,7 +100,7 @@ ___
### confirmInventory
▸ **confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\>
**confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\>
#### Parameters
@@ -167,7 +167,7 @@ ___
### createInventoryItem
▸ **createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
**createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
#### Parameters
@@ -218,7 +218,7 @@ ___
### createInventoryItems
▸ **createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\>
**createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\>
#### Parameters
@@ -278,7 +278,7 @@ ___
### createInventoryLevel
▸ **createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
**createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
#### Parameters
@@ -329,7 +329,7 @@ ___
### createInventoryLevels
▸ **createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\>
**createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\>
#### Parameters
@@ -389,7 +389,7 @@ ___
### createReservationItem
▸ **createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
**createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
#### Parameters
@@ -440,7 +440,7 @@ ___
### createReservationItems
▸ **createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\>
**createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\>
#### Parameters
@@ -500,7 +500,7 @@ ___
### deleteInventoryItem
▸ **deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
**deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -542,7 +542,7 @@ ___
### deleteInventoryItemLevelByLocationId
▸ **deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
**deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -584,7 +584,7 @@ ___
### deleteInventoryLevel
▸ **deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\>
**deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -634,7 +634,7 @@ ___
### deleteReservationItem
▸ **deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\>
**deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -676,7 +676,7 @@ ___
### deleteReservationItemByLocationId
▸ **deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
**deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -718,7 +718,7 @@ ___
### deleteReservationItemsByLineItem
▸ **deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\>
**deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -760,7 +760,7 @@ ___
### listInventoryItems
▸ **listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\>
**listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\>
#### Parameters
@@ -827,7 +827,7 @@ ___
### listInventoryLevels
▸ **listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\>
**listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\>
#### Parameters
@@ -894,7 +894,7 @@ ___
### listReservationItems
▸ **listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\>
**listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\>
#### Parameters
@@ -961,7 +961,7 @@ ___
### restoreInventoryItem
▸ **restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
**restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -1003,7 +1003,7 @@ ___
### retrieveAvailableQuantity
▸ **retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
**retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
#### Parameters
@@ -1062,7 +1062,7 @@ ___
### retrieveInventoryItem
▸ **retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
**retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
#### Parameters
@@ -1121,7 +1121,7 @@ ___
### retrieveInventoryLevel
▸ **retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
**retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
#### Parameters
@@ -1180,7 +1180,7 @@ ___
### retrieveReservationItem
▸ **retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
**retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
#### Parameters
@@ -1231,7 +1231,7 @@ ___
### retrieveReservedQuantity
▸ **retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
**retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
#### Parameters
@@ -1290,7 +1290,7 @@ ___
### retrieveStockedQuantity
▸ **retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
**retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
#### Parameters
@@ -1349,7 +1349,7 @@ ___
### updateInventoryItem
▸ **updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
**updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\>
#### Parameters
@@ -1408,7 +1408,7 @@ ___
### updateInventoryLevel
▸ **updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
**updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\>
#### Parameters
@@ -1475,7 +1475,7 @@ ___
### updateInventoryLevels
▸ **updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\>
**updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\>
#### Parameters
@@ -1535,7 +1535,7 @@ ___
### updateReservationItem
▸ **updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
**updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx
+8 -8
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addDocuments
▸ **addDocuments**(`indexName`, `documents`, `type`): `unknown`
**addDocuments**(`indexName`, `documents`, `type`): `unknown`
Used to index documents by the search engine provider
@@ -81,7 +81,7 @@ ___
### createIndex
▸ **createIndex**(`indexName`, `options`): `unknown`
**createIndex**(`indexName`, `options`): `unknown`
Used to create an index
@@ -125,7 +125,7 @@ ___
### deleteAllDocuments
▸ **deleteAllDocuments**(`indexName`): `unknown`
**deleteAllDocuments**(`indexName`): `unknown`
Used to delete all documents
@@ -161,7 +161,7 @@ ___
### deleteDocument
▸ **deleteDocument**(`indexName`, `document_id`): `unknown`
**deleteDocument**(`indexName`, `document_id`): `unknown`
Used to delete document
@@ -205,7 +205,7 @@ ___
### getIndex
▸ **getIndex**(`indexName`): `unknown`
**getIndex**(`indexName`): `unknown`
Used to get an index
@@ -241,7 +241,7 @@ ___
### replaceDocuments
▸ **replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
**replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
Used to replace documents
@@ -293,7 +293,7 @@ ___
### search
▸ **search**(`indexName`, `query`, `options`): `unknown`
**search**(`indexName`, `query`, `options`): `unknown`
Used to search for a document in an index
@@ -345,7 +345,7 @@ ___
### updateSettings
▸ **updateSettings**(`indexName`, `settings`): `unknown`
**updateSettings**(`indexName`, `settings`): `unknown`
Used to update the settings of an index
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_joinerConfig
▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
**__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
#### Returns
@@ -33,7 +33,7 @@ ___
### create
▸ **create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
**create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
#### Parameters
@@ -84,7 +84,7 @@ ___
### delete
▸ **delete**(`id`, `context?`): `Promise`<`void`\>
**delete**(`id`, `context?`): `Promise`<`void`\>
#### Parameters
@@ -126,7 +126,7 @@ ___
### list
▸ **list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\>
**list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\>
#### Parameters
@@ -194,7 +194,7 @@ ___
### listAndCount
▸ **listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\>
**listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\>
#### Parameters
@@ -261,7 +261,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
**retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
#### Parameters
@@ -320,7 +320,7 @@ ___
### update
▸ **update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
**update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx)
**withTransaction**(`transactionManager?`): [`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [iterator]
▸ **[iterator]**(): [`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\>
**[iterator]**(): [`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\>
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx
+4 -4
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [iterator]
▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\>
**[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\>
#### Returns
@@ -46,7 +46,7 @@ ___
### next
▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
**next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
#### Parameters
@@ -93,7 +93,7 @@ ___
### return
▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
`Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
#### Parameters
@@ -140,7 +140,7 @@ ___
### throw
▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
`Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx
+3 -3
View File
@@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### next
▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
**next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
#### Parameters
@@ -75,7 +75,7 @@ ___
### return
▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
`Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
#### Parameters
@@ -109,7 +109,7 @@ ___
### throw
▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
`Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx
+6 -6
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### hasOwnProperty
▸ **hasOwnProperty**(`v`): `boolean`
**hasOwnProperty**(`v`): `boolean`
Determines whether an object has a property with the specified name.
@@ -61,7 +61,7 @@ ___
### isPrototypeOf
▸ **isPrototypeOf**(`v`): `boolean`
**isPrototypeOf**(`v`): `boolean`
Determines whether an object exists in another object's prototype chain.
@@ -97,7 +97,7 @@ ___
### propertyIsEnumerable
▸ **propertyIsEnumerable**(`v`): `boolean`
**propertyIsEnumerable**(`v`): `boolean`
Determines whether a specified property is enumerable.
@@ -133,7 +133,7 @@ ___
### toLocaleString
▸ **toLocaleString**(): `string`
**toLocaleString**(): `string`
Returns a date converted to a string using the current locale.
@@ -156,7 +156,7 @@ ___
### toString
▸ **toString**(): `string`
**toString**(): `string`
Returns a string representation of an object.
@@ -179,7 +179,7 @@ ___
### valueOf
▸ **valueOf**(): [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object)
**valueOf**(): [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object)
Returns the primitive value of the specified object.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### callback
▸ **callback**(`bytesWritten`, `buf`): `boolean`
**callback**(`bytesWritten`, `buf`): `boolean`
This function is called for every chunk of incoming data.
Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### then
▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\>
**then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\>
Attaches callbacks for the resolution and/or rejection of the Promise.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### QueuingStrategySize
▸ **QueuingStrategySize**(`chunk?`): `number`
**QueuingStrategySize**(`chunk?`): `number`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx
+30 -30
View File
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
#### Returns
@@ -67,7 +67,7 @@ ___
### addListener
▸ **addListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**addListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -119,7 +119,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -207,7 +207,7 @@ ___
### end
▸ **end**(`cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**end**(`cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -241,7 +241,7 @@ ___
[WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end)
▸ **end**(`data`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**end**(`data`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -283,7 +283,7 @@ ___
[WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end)
▸ **end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -337,7 +337,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -392,7 +392,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
@@ -424,7 +424,7 @@ ___
### isPaused
▸ **isPaused**(): `boolean`
**isPaused**(): `boolean`
#### Returns
@@ -449,7 +449,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -503,7 +503,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -555,7 +555,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**off**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Alias for `emitter.removeListener()`.
@@ -607,7 +607,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**on**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -684,7 +684,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**once**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -759,7 +759,7 @@ ___
### pause
▸ **pause**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**pause**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Returns
@@ -784,7 +784,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -840,7 +840,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**prependListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -903,7 +903,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**prependOnceListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -964,7 +964,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -1034,7 +1034,7 @@ ___
### read
▸ **read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
#### Parameters
@@ -1072,7 +1072,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**removeAllListeners**(`event?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -1122,7 +1122,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**removeListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1252,7 +1252,7 @@ ___
### resume
▸ **resume**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**resume**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Returns
@@ -1277,7 +1277,7 @@ ___
### setEncoding
▸ **setEncoding**(`encoding`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**setEncoding**(`encoding`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -1315,7 +1315,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**setMaxListeners**(`n`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1364,7 +1364,7 @@ ___
### unpipe
▸ **unpipe**(`destination?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**unpipe**(`destination?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -1402,7 +1402,7 @@ ___
### unshift
▸ **unshift**(`chunk`, `encoding?`): `void`
**unshift**(`chunk`, `encoding?`): `void`
#### Parameters
@@ -1448,7 +1448,7 @@ ___
### wrap
▸ **wrap**(`oldStream`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
**wrap**(`oldStream`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx)
#### Parameters
@@ -1486,7 +1486,7 @@ ___
### write
▸ **write**(`buffer`, `cb?`): `boolean`
**write**(`buffer`, `cb?`): `boolean`
#### Parameters
@@ -1528,7 +1528,7 @@ ___
[WritableStream](admin_discounts.internal.WritableStream.mdx).[write](admin_discounts.internal.WritableStream.mdx#write)
▸ **write**(`str`, `encoding?`, `cb?`): `boolean`
**write**(`str`, `encoding?`, `cb?`): `boolean`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx
+3 -3
View File
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### close
▸ **close**(): `void`
**close**(): `void`
#### Returns
@@ -54,7 +54,7 @@ ___
### enqueue
▸ **enqueue**(`chunk`): `void`
**enqueue**(`chunk`): `void`
#### Parameters
@@ -88,7 +88,7 @@ ___
### error
▸ **error**(`error?`): `void`
**error**(`error?`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### ReadableByteStreamControllerCallback
▸ **ReadableByteStreamControllerCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**ReadableByteStreamControllerCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx
+7 -7
View File
@@ -40,7 +40,7 @@ This Streams API interface represents a readable stream of byte data.
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\>
**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\>
#### Returns
@@ -61,7 +61,7 @@ ___
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
#### Parameters
@@ -95,7 +95,7 @@ ___
### getReader
▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\>
**getReader**(): [`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\>
#### Returns
@@ -116,7 +116,7 @@ ___
### pipeThrough
▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\>
**pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\>
<ParameterTypes parameters={[
{
@@ -169,7 +169,7 @@ ___
### pipeTo
▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\>
**pipeTo**(`destination`, `options?`): `Promise`<`void`\>
#### Parameters
@@ -211,7 +211,7 @@ ___
### tee
▸ **tee**(): [[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>]
**tee**(): [[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>]
#### Returns
@@ -249,7 +249,7 @@ ___
### values
▸ **values**(`options?`): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\>
**values**(`options?`): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx
+25 -25
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
#### Returns
@@ -59,7 +59,7 @@ ___
### addListener
▸ **addListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**addListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -111,7 +111,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -199,7 +199,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -254,7 +254,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
@@ -286,7 +286,7 @@ ___
### isPaused
▸ **isPaused**(): `boolean`
**isPaused**(): `boolean`
#### Returns
@@ -307,7 +307,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -361,7 +361,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -413,7 +413,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**off**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Alias for `emitter.removeListener()`.
@@ -465,7 +465,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**on**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -542,7 +542,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**once**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -617,7 +617,7 @@ ___
### pause
▸ **pause**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**pause**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
#### Returns
@@ -638,7 +638,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -690,7 +690,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**prependListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -753,7 +753,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**prependOnceListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -814,7 +814,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -884,7 +884,7 @@ ___
### read
▸ **read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
**read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)
#### Parameters
@@ -918,7 +918,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**removeAllListeners**(`event?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -968,7 +968,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**removeListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1098,7 +1098,7 @@ ___
### resume
▸ **resume**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**resume**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
#### Returns
@@ -1119,7 +1119,7 @@ ___
### setEncoding
▸ **setEncoding**(`encoding`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**setEncoding**(`encoding`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
#### Parameters
@@ -1153,7 +1153,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**setMaxListeners**(`n`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1202,7 +1202,7 @@ ___
### unpipe
▸ **unpipe**(`destination?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**unpipe**(`destination?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
#### Parameters
@@ -1236,7 +1236,7 @@ ___
### unshift
▸ **unshift**(`chunk`, `encoding?`): `void`
**unshift**(`chunk`, `encoding?`): `void`
#### Parameters
@@ -1278,7 +1278,7 @@ ___
### wrap
▸ **wrap**(`oldStream`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
**wrap**(`oldStream`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx
+3 -3
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### close
▸ **close**(): `void`
**close**(): `void`
#### Returns
@@ -59,7 +59,7 @@ ___
### enqueue
▸ **enqueue**(`chunk?`): `void`
**enqueue**(`chunk?`): `void`
#### Parameters
@@ -93,7 +93,7 @@ ___
### error
▸ **error**(`e?`): `void`
**error**(`e?`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx
+3 -3
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
#### Parameters
@@ -76,7 +76,7 @@ ___
### read
▸ **read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\>
**read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\>
#### Returns
@@ -106,7 +106,7 @@ ___
### releaseLock
▸ **releaseLock**(): `void`
**releaseLock**(): `void`
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### ReadableStreamErrorCallback
▸ **ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### slice
▸ **slice**(`begin`, `end?`): [`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer)
**slice**(`begin`, `end?`): [`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer)
Returns a section of an SharedArrayBuffer.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx
+8 -8
View File
@@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
`Optional` **construct**(`this`, `callback`): `void`
#### Parameters
@@ -175,7 +175,7 @@ ___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
`Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
@@ -229,7 +229,7 @@ ___
### final
▸ `Optional` **final**(`this`, `callback`): `void`
`Optional` **final**(`this`, `callback`): `void`
#### Parameters
@@ -275,7 +275,7 @@ ___
### flush
▸ `Optional` **flush**(`this`, `callback`): `void`
`Optional` **flush**(`this`, `callback`): `void`
#### Parameters
@@ -317,7 +317,7 @@ ___
### read
▸ `Optional` **read**(`this`, `size`): `void`
`Optional` **read**(`this`, `size`): `void`
#### Parameters
@@ -363,7 +363,7 @@ ___
### transform
▸ `Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void`
`Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -421,7 +421,7 @@ ___
### write
▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -483,7 +483,7 @@ ___
### writev
▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void`
`Optional` **writev**(`this`, `chunks`, `callback`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkAbortCallback
▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkCloseCallback
▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkStartCallback
▸ **UnderlyingSinkStartCallback**(`controller`): `any`
**UnderlyingSinkStartCallback**(`controller`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkWriteCallback
▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourceCancelCallback
▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourcePullCallback
▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourceStartCallback
▸ **UnderlyingSourceStartCallback**(`controller`): `any`
**UnderlyingSourceStartCallback**(`controller`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx
+3 -3
View File
@@ -42,7 +42,7 @@ built-in back pressure and queuing.
### abort
▸ **abort**(`reason?`): `Promise`<`void`\>
**abort**(`reason?`): `Promise`<`void`\>
#### Parameters
@@ -76,7 +76,7 @@ ___
### close
▸ **close**(): `Promise`<`void`\>
**close**(): `Promise`<`void`\>
#### Returns
@@ -97,7 +97,7 @@ ___
### getWriter
▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\>
**getWriter**(): [`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\>
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx
+20 -20
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addListener
▸ **addListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**addListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -81,7 +81,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -169,7 +169,7 @@ ___
### end
▸ **end**(`cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**end**(`cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
#### Parameters
@@ -199,7 +199,7 @@ ___
}
]} />
▸ **end**(`data`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**end**(`data`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
#### Parameters
@@ -237,7 +237,7 @@ ___
}
]} />
▸ **end**(`str`, `encoding?`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**end**(`str`, `encoding?`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
#### Parameters
@@ -287,7 +287,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -342,7 +342,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
@@ -374,7 +374,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -428,7 +428,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -480,7 +480,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**off**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Alias for `emitter.removeListener()`.
@@ -532,7 +532,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**on**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -609,7 +609,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**once**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -684,7 +684,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**prependListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -747,7 +747,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**prependOnceListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -808,7 +808,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -878,7 +878,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**removeAllListeners**(`event?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -928,7 +928,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**removeListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1058,7 +1058,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
**setMaxListeners**(`n`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1107,7 +1107,7 @@ ___
### write
▸ **write**(`buffer`, `cb?`): `boolean`
**write**(`buffer`, `cb?`): `boolean`
#### Parameters
@@ -1145,7 +1145,7 @@ ___
}
]} />
▸ **write**(`str`, `encoding?`, `cb?`): `boolean`
**write**(`str`, `encoding?`, `cb?`): `boolean`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ instance to manipulate.
### error
▸ **error**(`e?`): `void`
**error**(`e?`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx
+4 -4
View File
@@ -59,7 +59,7 @@ sink.
### abort
▸ **abort**(`reason?`): `Promise`<`void`\>
**abort**(`reason?`): `Promise`<`void`\>
#### Parameters
@@ -93,7 +93,7 @@ ___
### close
▸ **close**(): `Promise`<`void`\>
**close**(): `Promise`<`void`\>
#### Returns
@@ -114,7 +114,7 @@ ___
### releaseLock
▸ **releaseLock**(): `void`
**releaseLock**(): `void`
#### Returns
@@ -135,7 +135,7 @@ ___
### write
▸ **write**(`chunk?`): `Promise`<`void`\>
**write**(`chunk?`): `Promise`<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addEventListener
▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any`
**addEventListener**(`eventName`, `listener`, `opts?`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### once
▸ **once**(`eventName`, `listener`): [`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx)
**once**(`eventName`, `listener`): [`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx
+13 -13
View File
@@ -19,7 +19,7 @@ Fullfillment provider plugin services should extend the AbstractFulfillmentServi
### calculatePrice
▸ **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\>
**calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\>
Used to calculate a price for a given shipping option.
@@ -80,7 +80,7 @@ ___
### canCalculate
▸ **canCalculate**(`data`): `Promise`<`boolean`\>
**canCalculate**(`data`): `Promise`<`boolean`\>
Used to determine if a shipping option can have a calculated price
@@ -125,7 +125,7 @@ ___
### cancelFulfillment
▸ **cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\>
**cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\>
Cancel a fulfillment using data from the fulfillment
@@ -170,7 +170,7 @@ ___
### createFulfillment
▸ **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\>
**createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\>
Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order.
The returned value of this method will populate the `fulfillment.data` field.
@@ -240,7 +240,7 @@ ___
### createReturn
▸ **createReturn**(`returnOrder`): `Promise`<Record<`string`, `unknown`\>\>
**createReturn**(`returnOrder`): `Promise`<Record<`string`, `unknown`\>\>
Used to create a return order. Should return the data necessary for future
operations on the return; in particular the data may be used to receive
@@ -304,7 +304,7 @@ ___
### getFulfillmentDocuments
▸ **getFulfillmentDocuments**(`data`): `Promise`<`any`\>
**getFulfillmentDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents associated with a fulfillment.
@@ -349,7 +349,7 @@ ___
### getFulfillmentOptions
▸ **getFulfillmentOptions**(): `Promise`<`any`[]\>
**getFulfillmentOptions**(): `Promise`<`any`[]\>
Called before a shipping option is created in Admin. The method should
return all of the options that the fulfillment provider can be used with,
@@ -395,7 +395,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
Return a unique identifier to retrieve the fulfillment plugin provider
@@ -418,7 +418,7 @@ ___
### getReturnDocuments
▸ **getReturnDocuments**(`data`): `Promise`<`any`\>
**getReturnDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents related to a return order.
@@ -463,7 +463,7 @@ ___
### getShipmentDocuments
▸ **getShipmentDocuments**(`data`): `Promise`<`any`\>
**getShipmentDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents related to a shipment.
@@ -508,7 +508,7 @@ ___
### retrieveDocuments
▸ **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\>
**retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\>
#### Parameters
@@ -559,7 +559,7 @@ ___
### validateFulfillmentData
▸ **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<Record<`string`, `unknown`\>\>
**validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<Record<`string`, `unknown`\>\>
Called before a shipping method is set on a cart to ensure that the data
sent with the shipping method is valid. The data object may contain extra
@@ -641,7 +641,7 @@ ___
### validateOption
▸ **validateOption**(`data`): `Promise`<`boolean`\>
**validateOption**(`data`): `Promise`<`boolean`\>
Called before a shipping option is created in Admin. Use this to ensure
that a fulfillment option does in fact exist.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx
+8 -8
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -163,7 +163,7 @@ ___
### buildTemplate
▸ **buildTemplate**(): `Promise`<`string`\>
**buildTemplate**(): `Promise`<`string`\>
Builds and returns a template file that can be downloaded and filled in
@@ -195,7 +195,7 @@ ___
### preProcessBatchJob
▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
Method for pre-processing a batch job
@@ -231,7 +231,7 @@ ___
### prepareBatchJobForProcessing
▸ **prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
**prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
Method for preparing a batch job for processing
@@ -284,7 +284,7 @@ ___
### processJob
▸ **processJob**(`batchJobId`): `Promise`<`void`\>
**processJob**(`batchJobId`): `Promise`<`void`\>
Method does the actual processing of the job. Should report back on the progress of the operation.
@@ -320,7 +320,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -358,7 +358,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx)
**withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx
+1 -1
View File
@@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### complete
▸ **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\>
**complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\>
Takes a cart id and completes the cart. This for example takes place when
creating an order or confirming a swap.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx
+10 -10
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -163,7 +163,7 @@ ___
### delete
▸ **delete**(`fileData`): `Promise`<`void`\>
**delete**(`fileData`): `Promise`<`void`\>
remove file from fileservice
@@ -199,7 +199,7 @@ ___
### getDownloadStream
▸ **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\>
**getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\>
download file from fileservice as stream
@@ -244,7 +244,7 @@ ___
### getPresignedDownloadUrl
▸ **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\>
**getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\>
Generate a presigned download url to obtain a file
@@ -289,7 +289,7 @@ ___
### getUploadStreamDescriptor
▸ **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\>
**getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\>
upload file to fileservice from stream
@@ -334,7 +334,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -372,7 +372,7 @@ ___
### upload
▸ **upload**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
**upload**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
upload file to fileservice
@@ -417,7 +417,7 @@ ___
### uploadProtected
▸ **uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
**uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
upload private file to fileservice
@@ -462,7 +462,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`IFileService`](admin_discounts.internal.internal.IFileService.mdx)
**withTransaction**(`transactionManager?`): [`IFileService`](admin_discounts.internal.internal.IFileService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx
+6 -6
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -163,7 +163,7 @@ ___
### resendNotification
▸ **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
**resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
#### Parameters
@@ -222,7 +222,7 @@ ___
### sendNotification
▸ **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
**sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
#### Parameters
@@ -281,7 +281,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -319,7 +319,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx)
**withTransaction**(`transactionManager?`): [`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx
+3 -3
View File
@@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### calculateVariantPrice
▸ **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\>
**calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\>
Calculate the original and discount price for a given variant in a set of
circumstances described in the context.
@@ -87,7 +87,7 @@ ___
### onVariantsPricesUpdate
▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\>
**onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\>
Notify price selection strategy that variants prices have been updated.
@@ -123,7 +123,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)
**withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### calculate
▸ **calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\>
**calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\>
Calculates the tax amount for a given set of line items under applicable
tax conditions and calculation contexts.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ items and shipping methods.
### getTaxLines
▸ **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\>
**getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\>
Retrieves the numerical tax lines for a calculation context.
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx
+80 -80
View File
@@ -313,7 +313,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
#### Returns
@@ -347,7 +347,7 @@ ___
### \_construct
▸ `Optional` **_construct**(`callback`): `void`
`Optional` **_construct**(`callback`): `void`
#### Parameters
@@ -385,7 +385,7 @@ ___
### \_destroy
▸ **_destroy**(`error`, `callback`): `void`
**_destroy**(`error`, `callback`): `void`
#### Parameters
@@ -431,7 +431,7 @@ ___
### \_read
▸ **_read**(`size`): `void`
**_read**(`size`): `void`
#### Parameters
@@ -469,7 +469,7 @@ ___
### addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Event emitter
The defined events on documents including:
@@ -521,7 +521,7 @@ The defined events on documents including:
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -563,7 +563,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -605,7 +605,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -647,7 +647,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -689,7 +689,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -731,7 +731,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -773,7 +773,7 @@ Request.addListener
Request.addListener
▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -819,7 +819,7 @@ ___
### destroy
▸ **destroy**(`error?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**destroy**(`error?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed
as an argument to any listeners on the event.
@@ -864,7 +864,7 @@ ___
### emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -898,7 +898,7 @@ ___
Request.emit
▸ **emit**(`event`, `chunk`): `boolean`
**emit**(`event`, `chunk`): `boolean`
#### Parameters
@@ -940,7 +940,7 @@ Request.emit
Request.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -974,7 +974,7 @@ Request.emit
Request.emit
▸ **emit**(`event`, `err`): `boolean`
**emit**(`event`, `err`): `boolean`
#### Parameters
@@ -1016,7 +1016,7 @@ Request.emit
Request.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1050,7 +1050,7 @@ Request.emit
Request.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1084,7 +1084,7 @@ Request.emit
Request.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1118,7 +1118,7 @@ Request.emit
Request.emit
▸ **emit**(`event`, `...args`): `boolean`
**emit**(`event`, `...args`): `boolean`
#### Parameters
@@ -1164,7 +1164,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -1219,7 +1219,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
@@ -1251,7 +1251,7 @@ ___
### isPaused
▸ **isPaused**(): `boolean`
**isPaused**(): `boolean`
The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most
typical cases, there will be no reason to
@@ -1294,7 +1294,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -1348,7 +1348,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1400,7 +1400,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**off**(`eventName`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Alias for `emitter.removeListener()`.
@@ -1452,7 +1452,7 @@ ___
### on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1494,7 +1494,7 @@ ___
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1536,7 +1536,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1578,7 +1578,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1620,7 +1620,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1662,7 +1662,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1704,7 +1704,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1746,7 +1746,7 @@ Request.on
Request.on
▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1792,7 +1792,7 @@ ___
### once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1834,7 +1834,7 @@ ___
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1876,7 +1876,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1918,7 +1918,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -1960,7 +1960,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2002,7 +2002,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2044,7 +2044,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2086,7 +2086,7 @@ Request.once
Request.once
▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2132,7 +2132,7 @@ ___
### pause
▸ **pause**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**pause**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
The `readable.pause()` method will cause a stream in flowing mode to stop
emitting `'data'` events, switching out of flowing mode. Any data that
@@ -2180,7 +2180,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -2236,7 +2236,7 @@ ___
### prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2278,7 +2278,7 @@ ___
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2320,7 +2320,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2362,7 +2362,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2404,7 +2404,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2446,7 +2446,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2488,7 +2488,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2530,7 +2530,7 @@ Request.prependListener
Request.prependListener
▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2576,7 +2576,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2618,7 +2618,7 @@ ___
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2660,7 +2660,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2702,7 +2702,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2744,7 +2744,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2786,7 +2786,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2828,7 +2828,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2870,7 +2870,7 @@ Request.prependOnceListener
Request.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -2916,7 +2916,7 @@ ___
### push
▸ **push**(`chunk`, `encoding?`): `boolean`
**push**(`chunk`, `encoding?`): `boolean`
#### Parameters
@@ -2962,7 +2962,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -3032,7 +3032,7 @@ ___
### read
▸ **read**(`size?`): `any`
**read**(`size?`): `any`
The `readable.read()` method reads data out of the internal buffer and
returns it. If no data is available to be read, `null` is returned. By default,
@@ -3147,7 +3147,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeAllListeners**(`event?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -3197,7 +3197,7 @@ ___
### removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3239,7 +3239,7 @@ ___
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3281,7 +3281,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3323,7 +3323,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3365,7 +3365,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3407,7 +3407,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3449,7 +3449,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3491,7 +3491,7 @@ Request.removeListener
Request.removeListener
▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
#### Parameters
@@ -3537,7 +3537,7 @@ ___
### resume
▸ **resume**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**resume**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
The `readable.resume()` method causes an explicitly paused `Readable` stream to
resume emitting `'data'` events, switching the stream into flowing mode.
@@ -3582,7 +3582,7 @@ ___
### setEncoding
▸ **setEncoding**(`encoding`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**setEncoding**(`encoding`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
The `readable.setEncoding()` method sets the character encoding for
data read from the `Readable` stream.
@@ -3645,7 +3645,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**setMaxListeners**(`n`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -3694,7 +3694,7 @@ ___
### setTimeout
▸ **setTimeout**(`msecs`, `callback?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**setTimeout**(`msecs`, `callback?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Calls `message.socket.setTimeout(msecs, callback)`.
@@ -3746,7 +3746,7 @@ ___
### unpipe
▸ **unpipe**(`destination?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**unpipe**(`destination?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
@@ -3811,7 +3811,7 @@ ___
### unshift
▸ **unshift**(`chunk`, `encoding?`): `void`
**unshift**(`chunk`, `encoding?`): `void`
Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
same as `readable.push(null)`, after which no more data can be written. The EOF
@@ -3921,7 +3921,7 @@ ___
### wrap
▸ **wrap**(`stream`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
**wrap**(`stream`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx)
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx
+11 -11
View File
@@ -19,7 +19,7 @@ This work is still experimental and can be changed until it becomes stable
### authorizePayment
▸ **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
**authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
Authorize an existing session if it is not already authorized
@@ -72,7 +72,7 @@ ___
### cancelPayment
▸ **cancelPayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**cancelPayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Cancel an existing session
@@ -117,7 +117,7 @@ ___
### capturePayment
▸ **capturePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**capturePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Capture an existing session
@@ -162,7 +162,7 @@ ___
### deletePayment
▸ **deletePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**deletePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Delete an existing session
@@ -207,7 +207,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
Return a unique identifier to retrieve the payment plugin provider
@@ -230,7 +230,7 @@ ___
### getPaymentStatus
▸ **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
**getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
Return the status of the session
@@ -307,7 +307,7 @@ ___
### initiatePayment
▸ **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
**initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
Initiate a payment session with the external provider
@@ -352,7 +352,7 @@ ___
### refundPayment
▸ **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Refund an existing session
@@ -405,7 +405,7 @@ ___
### retrievePayment
▸ **retrievePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**retrievePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Retrieve an existing session
@@ -450,7 +450,7 @@ ___
### updatePayment
▸ **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
**updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
Update an existing payment session
@@ -495,7 +495,7 @@ ___
### updatePaymentData
▸ **updatePaymentData**(`sessionId`, `data`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
**updatePaymentData**(`sessionId`, `data`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Update the session data for a payment session
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx
+19 -19
View File
@@ -67,7 +67,7 @@ in the near future use the new PaymentProcessor interface instead
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -92,7 +92,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -169,7 +169,7 @@ ___
### authorizePayment
▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
**authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
This will be
@@ -226,7 +226,7 @@ ___
### cancelPayment
▸ **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -275,7 +275,7 @@ ___
### capturePayment
▸ **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -324,7 +324,7 @@ ___
### createPayment
▸ **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
**createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
This will be
@@ -369,7 +369,7 @@ This will be
in the near future use PaymentProcessor.initiatePayment instead
▸ **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -418,7 +418,7 @@ ___
### deletePayment
▸ **deletePayment**(`paymentSession`): `Promise`<`void`\>
**deletePayment**(`paymentSession`): `Promise`<`void`\>
This will be
@@ -458,7 +458,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
#### Returns
@@ -479,7 +479,7 @@ ___
### getPaymentData
▸ **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -528,7 +528,7 @@ ___
### getStatus
▸ **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
**getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
This will be
@@ -609,7 +609,7 @@ ___
### refundPayment
▸ **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -666,7 +666,7 @@ ___
### retrievePayment
▸ **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -715,7 +715,7 @@ ___
### retrieveSavedMethods
▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\>
**retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\>
This will be
@@ -773,7 +773,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -811,7 +811,7 @@ ___
### updatePayment
▸ **updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
**updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
#### Parameters
@@ -858,7 +858,7 @@ ___
}
]} />
▸ **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -915,7 +915,7 @@ ___
### updatePaymentData
▸ **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
**updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -972,7 +972,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx)
**withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx
+4 -4
View File
@@ -69,7 +69,7 @@ Provides information about files and allows JavaScript in a web page to access t
### arrayBuffer
▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
**arrayBuffer**(): `Promise`<`ArrayBuffer`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer)
@@ -96,7 +96,7 @@ ___
### slice
▸ **slice**(`start?`, `end?`, `contentType?`): `Blob`
**slice**(`start?`, `end?`, `contentType?`): `Blob`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice)
@@ -152,7 +152,7 @@ ___
### stream
▸ **stream**(): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
**stream**(): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream)
@@ -188,7 +188,7 @@ ___
### text
▸ **text**(): `Promise`<`string`\>
**text**(): `Promise`<`string`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### QueuingStrategySize
▸ **QueuingStrategySize**(`chunk`): `number`
**QueuingStrategySize**(`chunk`): `number`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx
+3 -3
View File
@@ -35,7 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### close
▸ **close**(): `void`
**close**(): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close)
@@ -58,7 +58,7 @@ ___
### enqueue
▸ **enqueue**(`chunk`): `void`
**enqueue**(`chunk`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue)
@@ -94,7 +94,7 @@ ___
### error
▸ **error**(`e?`): `void`
**error**(`e?`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx
+7 -7
View File
@@ -42,7 +42,7 @@ This Streams API interface represents a readable stream of byte data. The Fetch
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel)
@@ -78,7 +78,7 @@ ___
### getReader
▸ **getReader**(`options`): [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader)
**getReader**(`options`): [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader)
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader)
@@ -118,7 +118,7 @@ ___
}
]} />
▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
**getReader**(): [`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
#### Returns
@@ -135,7 +135,7 @@ ___
}
]} />
▸ **getReader**(`options?`): [`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\>
**getReader**(`options?`): [`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\>
#### Parameters
@@ -169,7 +169,7 @@ ___
### pipeThrough
▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\>
**pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough)
@@ -224,7 +224,7 @@ ___
### pipeTo
▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\>
**pipeTo**(`destination`, `options?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo)
@@ -268,7 +268,7 @@ ___
### tee
▸ **tee**(): [[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>]
**tee**(): [[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>]
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx
+3 -3
View File
@@ -27,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
@@ -67,7 +67,7 @@ ___
### read
▸ **read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\>
**read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read)
@@ -123,7 +123,7 @@ ___
### releaseLock
▸ **releaseLock**(): `void`
**releaseLock**(): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx
+2 -2
View File
@@ -27,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### respond
▸ **respond**(`bytesWritten`): `void`
**respond**(`bytesWritten`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond)
@@ -63,7 +63,7 @@ ___
### respondWithNewView
▸ **respondWithNewView**(`view`): `void`
**respondWithNewView**(`view`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx
+3 -3
View File
@@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### close
▸ **close**(): `void`
**close**(): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close)
@@ -63,7 +63,7 @@ ___
### enqueue
▸ **enqueue**(`chunk?`): `void`
**enqueue**(`chunk?`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue)
@@ -99,7 +99,7 @@ ___
### error
▸ **error**(`e?`): `void`
**error**(`e?`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx
+3 -3
View File
@@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
@@ -80,7 +80,7 @@ ___
### read
▸ **read**(): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\>
**read**(): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read)
@@ -112,7 +112,7 @@ ___
### releaseLock
▸ **releaseLock**(): `void`
**releaseLock**(): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`reason?`): `Promise`<`void`\>
**cancel**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkAbortCallback
▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkCloseCallback
▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Returns
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkStartCallback
▸ **UnderlyingSinkStartCallback**(`controller`): `any`
**UnderlyingSinkStartCallback**(`controller`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSinkWriteCallback
▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourceCancelCallback
▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourcePullCallback
▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
**UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx
+1 -1
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### UnderlyingSourceStartCallback
▸ **UnderlyingSourceStartCallback**(`controller`): `any`
**UnderlyingSourceStartCallback**(`controller`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx
+3 -3
View File
@@ -42,7 +42,7 @@ This Streams API interface provides a standard abstraction for writing streamin
### abort
▸ **abort**(`reason?`): `Promise`<`void`\>
**abort**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort)
@@ -78,7 +78,7 @@ ___
### close
▸ **close**(): `Promise`<`void`\>
**close**(): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close)
@@ -101,7 +101,7 @@ ___
### getWriter
▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
**getWriter**(): [`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ This Streams API interface represents a controller allowing control of a Writab
### error
▸ **error**(`e?`): `void`
**error**(`e?`): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error)
www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx
+4 -4
View File
@@ -58,7 +58,7 @@ This Streams API interface is the object returned by WritableStream.getWriter()
### abort
▸ **abort**(`reason?`): `Promise`<`void`\>
**abort**(`reason?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort)
@@ -94,7 +94,7 @@ ___
### close
▸ **close**(): `Promise`<`void`\>
**close**(): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close)
@@ -117,7 +117,7 @@ ___
### releaseLock
▸ **releaseLock**(): `void`
**releaseLock**(): `void`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock)
@@ -140,7 +140,7 @@ ___
### write
▸ **write**(`chunk?`): `Promise`<`void`\>
**write**(`chunk?`): `Promise`<`void`\>
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write)
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AxiosAdapter
▸ **AxiosAdapter**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
**AxiosAdapter**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx
+11 -11
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AxiosInstance
▸ **AxiosInstance**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
**AxiosInstance**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
#### Parameters
@@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AxiosInstance
▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
**AxiosInstance**(`url`, `config?`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\>
#### Parameters
@@ -141,7 +141,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### delete
▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
**delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -214,7 +214,7 @@ ___
### get
▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
**get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -287,7 +287,7 @@ ___
### getUri
▸ **getUri**(`config?`): `string`
**getUri**(`config?`): `string`
#### Parameters
@@ -325,7 +325,7 @@ ___
### head
▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
**head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -398,7 +398,7 @@ ___
### options
▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
**options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -471,7 +471,7 @@ ___
### patch
▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
**patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -552,7 +552,7 @@ ___
### post
▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
**post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -633,7 +633,7 @@ ___
### put
▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
**put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
@@ -714,7 +714,7 @@ ___
### request
▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\>
**request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\>
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx
+2 -2
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### eject
▸ **eject**(`id`): `void`
**eject**(`id`): `void`
#### Parameters
@@ -59,7 +59,7 @@ ___
### use
▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`): `number`
**use**<`T`\>(`onFulfilled?`, `onRejected?`): `number`
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosPromise.mdx
+3 -3
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### catch
▸ **catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\>
**catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\>
Attaches a callback for only the rejection of the Promise.
@@ -98,7 +98,7 @@ ___
### finally
▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\>\>
**finally**(`onfinally?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\>\>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
resolved value cannot be modified from the callback.
@@ -157,7 +157,7 @@ ___
### then
▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\>
**then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\>
Attaches callbacks for the resolution and/or rejection of the Promise.
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AxiosRequestTransformer
▸ **AxiosRequestTransformer**(`data`, `headers?`): `any`
**AxiosRequestTransformer**(`data`, `headers?`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AxiosResponseTransformer
▸ **AxiosResponseTransformer**(`data`, `headers?`): `any`
**AxiosResponseTransformer**(`data`, `headers?`): `any`
#### Parameters
www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx
+1 -1
View File
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### throwIfRequested
▸ **throwIfRequested**(): `void`
**throwIfRequested**(): `void`
#### Returns