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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncGenerator.mdx
+11 -11
View File
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -58,9 +58,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### next
### next
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -74,7 +74,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -90,9 +90,9 @@ ___
___
#### return
### return
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -106,7 +106,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -122,9 +122,9 @@ ___
___
#### throw
### throw
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -138,7 +138,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterable.mdx
+2 -2
View File
@@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterableIterator.mdx
+11 -11
View File
@@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### next
### next
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +72,9 @@ ___
___
#### return
### return
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,9 +104,9 @@ ___
___
#### throw
### throw
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -120,7 +120,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterator.mdx
+9 -9
View File
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### next
### next
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +72,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### return
### return
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,9 +104,9 @@ ___
___
#### throw
### throw
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -120,7 +120,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosInstance.mdx
+29 -27
View File
@@ -47,11 +47,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### delete
### delete
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -74,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -90,9 +92,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### get
### get
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -115,7 +117,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -131,9 +133,9 @@ ___
___
#### getUri
### getUri
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -147,7 +149,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -163,9 +165,9 @@ ___
___
#### head
### head
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -188,7 +190,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -204,9 +206,9 @@ ___
___
#### options
### options
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -229,7 +231,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -245,9 +247,9 @@ ___
___
#### patch
### patch
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -279,7 +281,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -295,9 +297,9 @@ ___
___
#### post
### post
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -329,7 +331,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -345,9 +347,9 @@ ___
___
#### put
### put
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -379,7 +381,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -395,9 +397,9 @@ ___
___
#### request
### request
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -411,7 +413,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosInterceptorManager.mdx
+6 -6
View File
@@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### eject
### eject
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -54,9 +54,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### use
### use
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -79,7 +79,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx
+11 -9
View File
@@ -34,13 +34,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### catch
### catch
Attaches a callback for only the rejection of the Promise.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -54,7 +56,7 @@ Attaches a callback for only the rejection of the Promise.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -70,12 +72,12 @@ Attaches a callback for only the rejection of the Promise.
___
#### finally
### finally
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
resolved value cannot be modified from the callback.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -89,7 +91,7 @@ resolved value cannot be modified from the callback.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -105,11 +107,11 @@ resolved value cannot be modified from the callback.
___
#### then
### then
Attaches callbacks for the resolution and/or rejection of the Promise.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -132,7 +134,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.BaseRepositoryService.mdx
+10 -10
View File
@@ -26,9 +26,9 @@ ORM directly and allows to switch to another ORM without changing the business l
## Methods
#### getActiveManager
### getActiveManager
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -44,9 +44,9 @@ ORM directly and allows to switch to another ORM without changing the business l
___
#### getFreshManager
### getFreshManager
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -62,9 +62,9 @@ ___
___
#### serialize
### serialize
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -87,7 +87,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -103,9 +103,9 @@ ___
___
#### transaction
### transaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -155,7 +155,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.Boolean.mdx
+2 -2
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### valueOf
### valueOf
Returns the primitive value of the specified object.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx
+297 -295
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/interfaces/internal.BufferConstructor.mdx
+41 -39
View File
@@ -24,9 +24,11 @@ Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\|
}
]} />
___
## Methods
#### alloc
### alloc
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled.
@@ -70,7 +72,7 @@ data that might not have been allocated for `Buffer`s.
A `TypeError` will be thrown if `size` is not a number.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -102,7 +104,7 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -122,7 +124,7 @@ v5.10.0
___
#### allocUnsafe
### allocUnsafe
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.
@@ -156,7 +158,7 @@ than or equal to half `Buffer.poolSize`. The
difference is subtle but can be important when an application requires the
additional performance that `Buffer.allocUnsafe()` provides.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -170,7 +172,7 @@ additional performance that `Buffer.allocUnsafe()` provides.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -190,7 +192,7 @@ v5.10.0
___
#### allocUnsafeSlow
### allocUnsafeSlow
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.
@@ -233,7 +235,7 @@ socket.on('readable', () => {
A `TypeError` will be thrown if `size` is not a number.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -247,7 +249,7 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -267,7 +269,7 @@ v5.12.0
___
#### byteLength
### byteLength
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
@@ -293,7 +295,7 @@ When `string` is a
Reference/Global\_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop-
er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -316,7 +318,7 @@ er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/SharedArrayBu
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -336,7 +338,7 @@ v0.1.90
___
#### compare
### compare
Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
@@ -352,7 +354,7 @@ console.log(arr.sort(Buffer.compare));
// (This result is equal to: [buf2, buf1].)
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -375,7 +377,7 @@ console.log(arr.sort(Buffer.compare));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -395,7 +397,7 @@ v0.11.13
___
#### concat
### concat
Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
@@ -431,7 +433,7 @@ console.log(bufA.length);
`Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -454,7 +456,7 @@ console.log(bufA.length);
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -474,7 +476,7 @@ v0.7.11
___
#### copyBytesFrom
### copyBytesFrom
Copies the underlying memory of `view` into a new `Buffer`.
@@ -487,7 +489,7 @@ console.log(buf[0]); // 255
console.log(buf[1]); // 255
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -519,7 +521,7 @@ console.log(buf[1]); // 255
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -539,7 +541,7 @@ v19.8.0
___
#### from
### from
`**from**(arrayBuffer, byteOffset?, length?): [Buffer](../../modules/internal.mdx#buffer)`
@@ -562,7 +564,7 @@ appropriate for `Buffer.from()` variants.
`Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -594,7 +596,7 @@ appropriate for `Buffer.from()` variants.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -616,7 +618,7 @@ v5.10.0
Creates a new Buffer using the passed &#123;data&#125;
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -630,7 +632,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -646,7 +648,7 @@ Creates a new Buffer using the passed &#123;data&#125;
`**from**(data): [Buffer](../../modules/internal.mdx#buffer)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -660,7 +662,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -680,7 +682,7 @@ Creates a new Buffer containing the given JavaScript string &#123;str&#125;.
If provided, the &#123;encoding&#125; parameter identifies the character encoding.
If not provided, &#123;encoding&#125; defaults to 'utf8'.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -703,7 +705,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -719,7 +721,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
___
#### isBuffer
### isBuffer
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
@@ -733,7 +735,7 @@ Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -747,7 +749,7 @@ Buffer.isBuffer(new Uint8Array(1024)); // false
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -767,7 +769,7 @@ v0.1.101
___
#### isEncoding
### isEncoding
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
@@ -788,7 +790,7 @@ console.log(Buffer.isEncoding(''));
// Prints: false
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -802,7 +804,7 @@ console.log(Buffer.isEncoding(''));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -822,11 +824,11 @@ v0.9.1
___
#### of
### of
Creates a new Buffer using the passed &#123;data&#125;
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -840,7 +842,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.CallSite.mdx
+26 -26
View File
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### getColumnNumber
### getColumnNumber
Current column number [if this function was defined in a script]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -28,12 +28,12 @@ Current column number [if this function was defined in a script]
___
#### getEvalOrigin
### getEvalOrigin
A call site object representing the location where eval was called
[if this function was created using a call to eval]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -49,11 +49,11 @@ A call site object representing the location where eval was called
___
#### getFileName
### getFileName
Name of the script [if this function was defined in a script]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -69,11 +69,11 @@ Name of the script [if this function was defined in a script]
___
#### getFunction
### getFunction
Current function
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -89,13 +89,13 @@ Current function
___
#### getFunctionName
### getFunctionName
Name of the current function, typically its name property.
If a name property is not available an attempt will be made to try
to infer a name from the function's context.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -111,11 +111,11 @@ to infer a name from the function's context.
___
#### getLineNumber
### getLineNumber
Current line number [if this function was defined in a script]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -131,12 +131,12 @@ Current line number [if this function was defined in a script]
___
#### getMethodName
### getMethodName
Name of the property [of "this" or one of its prototypes] that holds
the current function
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -152,11 +152,11 @@ the current function
___
#### getThis
### getThis
Value of "this"
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -172,14 +172,14 @@ Value of "this"
___
#### getTypeName
### getTypeName
Type of "this" as a string.
This is the name of the function stored in the constructor field of
"this", if available. Otherwise the object's [[Class]] internal
property.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -195,11 +195,11 @@ property.
___
#### isConstructor
### isConstructor
Is this a constructor call?
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -215,11 +215,11 @@ Is this a constructor call?
___
#### isEval
### isEval
Does this call take place in code defined by a call to eval?
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -235,11 +235,11 @@ Does this call take place in code defined by a call to eval?
___
#### isNative
### isNative
Is this call in native V8 code?
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -255,11 +255,11 @@ Is this call in native V8 code?
___
#### isToplevel
### isToplevel
Is this a toplevel invocation, that is, is "this" the global object?
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.CancelToken.mdx
+4 -2
View File
@@ -29,11 +29,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### throwIfRequested
### throwIfRequested
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.Disposable.mdx
+2 -2
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [dispose]
### [dispose]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.DuplexOptions.mdx
+20 -18
View File
@@ -137,11 +137,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### construct
### construct
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -164,7 +166,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -180,9 +182,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### destroy
### destroy
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -214,7 +216,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -230,9 +232,9 @@ ___
___
#### final
### final
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -255,7 +257,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -271,9 +273,9 @@ ___
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -296,7 +298,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -312,9 +314,9 @@ ___
___
#### write
### write
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -355,7 +357,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -371,9 +373,9 @@ ___
___
#### writev
### writev
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -405,7 +407,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.EventEmitter-2.mdx
+46 -46
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [captureRejectionSymbol]
### [captureRejectionSymbol]
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -58,11 +58,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### addListener
### addListener
Alias for `emitter.on(eventName, listener)`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -85,7 +85,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -105,7 +105,7 @@ v0.1.26
___
#### emit
### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -145,7 +145,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -168,7 +168,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -188,7 +188,7 @@ v0.1.26
___
#### eventNames
### eventNames
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -207,7 +207,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -227,12 +227,12 @@ v6.0.0
___
#### getMaxListeners
### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -252,13 +252,13 @@ v1.0.0
___
#### listenerCount
### listenerCount
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
in the list of the listeners of the event.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -281,7 +281,7 @@ in the list of the listeners of the event.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -301,7 +301,7 @@ v3.2.0
___
#### listeners
### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -313,7 +313,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -327,7 +327,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -347,11 +347,11 @@ v0.1.26
___
#### off
### off
Alias for `emitter.removeListener()`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -374,7 +374,7 @@ Alias for `emitter.removeListener()`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -394,7 +394,7 @@ v10.0.0
___
#### on
### on
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
@@ -423,7 +423,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -446,7 +446,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -466,7 +466,7 @@ v0.1.101
___
#### once
### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -493,7 +493,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -516,7 +516,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -536,7 +536,7 @@ v0.3.0
___
#### prependListener
### prependListener
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
@@ -551,7 +551,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -574,7 +574,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -594,7 +594,7 @@ v6.0.0
___
#### prependOnceListener
### prependOnceListener
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.
@@ -607,7 +607,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -630,7 +630,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -650,7 +650,7 @@ v6.0.0
___
#### rawListeners
### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -680,7 +680,7 @@ newListeners[0]();
emitter.emit('log');
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -694,7 +694,7 @@ emitter.emit('log');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -714,7 +714,7 @@ v9.4.0
___
#### removeAllListeners
### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -724,7 +724,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -738,7 +738,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -758,7 +758,7 @@ v0.1.26
___
#### removeListener
### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -840,7 +840,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -863,7 +863,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -883,7 +883,7 @@ v0.1.26
___
#### setMaxListeners
### setMaxListeners
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
@@ -892,7 +892,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -906,7 +906,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.File.mdx
+11 -9
View File
@@ -60,13 +60,15 @@ Provides information about files and allows JavaScript in a web page to access t
}
]} />
___
## Methods
#### arrayBuffer
### arrayBuffer
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -82,11 +84,11 @@ Provides information about files and allows JavaScript in a web page to access t
___
#### slice
### slice
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -118,7 +120,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -134,11 +136,11 @@ ___
___
#### stream
### stream
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -154,11 +156,11 @@ ___
___
#### text
### text
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ITransactionBaseService.mdx
+3 -3
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx
+2 -2
View File
@@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [iterator]
### [iterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.IterableIterator.mdx
+11 -11
View File
@@ -22,9 +22,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### [iterator]
### [iterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### next
### next
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +72,9 @@ ___
___
#### return
### return
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,9 +104,9 @@ ___
___
#### throw
### throw
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -120,7 +120,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterator.mdx
+9 -9
View File
@@ -40,9 +40,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### next
### next
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +72,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### return
### return
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,9 +104,9 @@ ___
___
#### throw
### throw
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -120,7 +120,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.OnReadOpts.mdx
+5 -3
View File
@@ -20,15 +20,17 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### callback
### callback
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.
Return false from this function to implicitly pause() the socket.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -51,7 +53,7 @@ Return false from this function to implicitly pause() the socket.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.PromiseLike.mdx
+3 -3
View File
@@ -22,11 +22,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### then
### then
Attaches callbacks for the resolution and/or rejection of the Promise.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx
+86 -84
View File
@@ -29,11 +29,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -49,9 +51,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### [captureRejectionSymbol]
### [captureRejectionSymbol]
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -83,7 +85,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -99,11 +101,11 @@ ___
___
#### addListener
### addListener
Alias for `emitter.on(eventName, listener)`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -126,7 +128,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -146,7 +148,7 @@ v0.1.26
___
#### emit
### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -186,7 +188,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -209,7 +211,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -229,11 +231,11 @@ v0.1.26
___
#### end
### end
`**end**(cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -247,7 +249,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -263,7 +265,7 @@ ___
`**end**(data, cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -286,7 +288,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -302,7 +304,7 @@ ___
`**end**(str, encoding?, cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -334,7 +336,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -350,7 +352,7 @@ ___
___
#### eventNames
### eventNames
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -369,7 +371,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -389,12 +391,12 @@ v6.0.0
___
#### getMaxListeners
### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -414,9 +416,9 @@ v1.0.0
___
#### isPaused
### isPaused
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -432,13 +434,13 @@ ___
___
#### listenerCount
### listenerCount
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
in the list of the listeners of the event.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -461,7 +463,7 @@ in the list of the listeners of the event.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -481,7 +483,7 @@ v3.2.0
___
#### listeners
### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -493,7 +495,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -507,7 +509,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -527,11 +529,11 @@ v0.1.26
___
#### off
### off
Alias for `emitter.removeListener()`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -554,7 +556,7 @@ Alias for `emitter.removeListener()`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -574,7 +576,7 @@ v10.0.0
___
#### on
### on
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
@@ -603,7 +605,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -626,7 +628,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -646,7 +648,7 @@ v0.1.101
___
#### once
### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -673,7 +675,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -696,7 +698,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -716,9 +718,9 @@ v0.3.0
___
#### pause
### pause
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -734,9 +736,9 @@ ___
___
#### pipe
### pipe
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -768,7 +770,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -784,7 +786,7 @@ ___
___
#### prependListener
### prependListener
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
@@ -799,7 +801,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -822,7 +824,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -842,7 +844,7 @@ v6.0.0
___
#### prependOnceListener
### prependOnceListener
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.
@@ -855,7 +857,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -878,7 +880,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -898,7 +900,7 @@ v6.0.0
___
#### rawListeners
### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -928,7 +930,7 @@ newListeners[0]();
emitter.emit('log');
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -942,7 +944,7 @@ emitter.emit('log');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -962,9 +964,9 @@ v9.4.0
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -978,7 +980,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -994,7 +996,7 @@ ___
___
#### removeAllListeners
### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -1004,7 +1006,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1018,7 +1020,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1038,7 +1040,7 @@ v0.1.26
___
#### removeListener
### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1120,7 +1122,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1143,7 +1145,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1163,9 +1165,9 @@ v0.1.26
___
#### resume
### resume
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1181,9 +1183,9 @@ ___
___
#### setEncoding
### setEncoding
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1197,7 +1199,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1213,7 +1215,7 @@ ___
___
#### setMaxListeners
### setMaxListeners
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
@@ -1222,7 +1224,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1236,7 +1238,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1256,9 +1258,9 @@ v0.3.5
___
#### unpipe
### unpipe
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1272,7 +1274,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1288,9 +1290,9 @@ ___
___
#### unshift
### unshift
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1313,7 +1315,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1329,9 +1331,9 @@ ___
___
#### wrap
### wrap
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1345,7 +1347,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1361,11 +1363,11 @@ ___
___
#### write
### write
`**write**(buffer, cb?): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1388,7 +1390,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1404,7 +1406,7 @@ ___
`**write**(str, encoding?, cb?): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1436,7 +1438,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx
+10 -8
View File
@@ -29,11 +29,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### close
### close
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -49,9 +51,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### enqueue
### enqueue
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -65,7 +67,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -81,9 +83,9 @@ ___
___
#### error
### error
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -97,7 +99,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx
+10 -8
View File
@@ -31,13 +31,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### close
### close
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -53,11 +55,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### enqueue
### enqueue
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -71,7 +73,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -87,11 +89,11 @@ ___
___
#### error
### error
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -105,7 +107,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableOptions.mdx
+11 -9
View File
@@ -65,11 +65,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### construct
### construct
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -92,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -108,9 +110,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### destroy
### destroy
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -142,7 +144,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -158,9 +160,9 @@ ___
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -183,7 +185,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-1.mdx
+74 -72
View File
@@ -20,11 +20,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -40,9 +42,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### [captureRejectionSymbol]
### [captureRejectionSymbol]
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -74,7 +76,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -90,11 +92,11 @@ ___
___
#### addListener
### addListener
Alias for `emitter.on(eventName, listener)`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -117,7 +119,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -137,7 +139,7 @@ v0.1.26
___
#### emit
### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -177,7 +179,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -200,7 +202,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -220,7 +222,7 @@ v0.1.26
___
#### eventNames
### eventNames
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -239,7 +241,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -259,12 +261,12 @@ v6.0.0
___
#### getMaxListeners
### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -284,9 +286,9 @@ v1.0.0
___
#### isPaused
### isPaused
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -302,13 +304,13 @@ ___
___
#### listenerCount
### listenerCount
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
in the list of the listeners of the event.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -331,7 +333,7 @@ in the list of the listeners of the event.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -351,7 +353,7 @@ v3.2.0
___
#### listeners
### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -363,7 +365,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -377,7 +379,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -397,11 +399,11 @@ v0.1.26
___
#### off
### off
Alias for `emitter.removeListener()`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -424,7 +426,7 @@ Alias for `emitter.removeListener()`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -444,7 +446,7 @@ v10.0.0
___
#### on
### on
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
@@ -473,7 +475,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -496,7 +498,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -516,7 +518,7 @@ v0.1.101
___
#### once
### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -543,7 +545,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -566,7 +568,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -586,9 +588,9 @@ v0.3.0
___
#### pause
### pause
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -604,9 +606,9 @@ ___
___
#### pipe
### pipe
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -638,7 +640,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -654,7 +656,7 @@ ___
___
#### prependListener
### prependListener
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
@@ -669,7 +671,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -692,7 +694,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -712,7 +714,7 @@ v6.0.0
___
#### prependOnceListener
### prependOnceListener
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.
@@ -725,7 +727,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -748,7 +750,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -768,7 +770,7 @@ v6.0.0
___
#### rawListeners
### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -798,7 +800,7 @@ newListeners[0]();
emitter.emit('log');
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -812,7 +814,7 @@ emitter.emit('log');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -832,9 +834,9 @@ v9.4.0
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -848,7 +850,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -864,7 +866,7 @@ ___
___
#### removeAllListeners
### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -874,7 +876,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -888,7 +890,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -908,7 +910,7 @@ v0.1.26
___
#### removeListener
### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -990,7 +992,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1013,7 +1015,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1033,9 +1035,9 @@ v0.1.26
___
#### resume
### resume
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1051,9 +1053,9 @@ ___
___
#### setEncoding
### setEncoding
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1067,7 +1069,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1083,7 +1085,7 @@ ___
___
#### setMaxListeners
### setMaxListeners
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
@@ -1092,7 +1094,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1106,7 +1108,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1126,9 +1128,9 @@ v0.3.5
___
#### unpipe
### unpipe
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1142,7 +1144,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1158,9 +1160,9 @@ ___
___
#### unshift
### unshift
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1183,7 +1185,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1199,9 +1201,9 @@ ___
___
#### wrap
### wrap
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1215,7 +1217,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx
+22 -20
View File
@@ -36,11 +36,13 @@ This Streams API interface represents a readable stream of byte data.
}
]} />
___
## Methods
#### [asyncIterator]
### [asyncIterator]
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -56,9 +58,9 @@ This Streams API interface represents a readable stream of byte data.
___
#### cancel
### cancel
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -72,7 +74,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -88,11 +90,11 @@ ___
___
#### getReader
### getReader
`**getReader**(): [ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader-1)&#60;R&#62;`
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -108,7 +110,7 @@ ___
`**getReader**(options): [ReadableStreamBYOBReader](../../modules/internal.mdx#readablestreambyobreader-1)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -131,7 +133,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -147,9 +149,9 @@ ___
___
#### pipeThrough
### pipeThrough
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +174,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -188,9 +190,9 @@ ___
___
#### pipeTo
### pipeTo
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -213,7 +215,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -229,9 +231,9 @@ ___
___
#### tee
### tee
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -247,9 +249,9 @@ ___
___
#### values
### values
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -272,7 +274,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx
+19 -17
View File
@@ -38,13 +38,15 @@ This Streams API interface represents a readable stream of byte data. The Fetch
}
]} />
___
## Methods
#### cancel
### cancel
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -58,7 +60,7 @@ This Streams API interface represents a readable stream of byte data. The Fetch
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -74,13 +76,13 @@ This Streams API interface represents a readable stream of byte data. The Fetch
___
#### getReader
### getReader
`**getReader**(options): [ReadableStreamBYOBReader](../../modules/internal.mdx#readablestreambyobreader)`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -103,7 +105,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -119,7 +121,7 @@ ___
`**getReader**(): [ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader)&#60;R&#62;`
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -135,7 +137,7 @@ ___
`**getReader**(options?): [ReadableStreamReader](../types/internal.ReadableStreamReader.mdx)&#60;R&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -149,7 +151,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -165,11 +167,11 @@ ___
___
#### pipeThrough
### pipeThrough
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +194,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -208,11 +210,11 @@ ___
___
#### pipeTo
### pipeTo
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -235,7 +237,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -251,11 +253,11 @@ ___
___
#### tee
### tee
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBReader-1.mdx
+10 -8
View File
@@ -20,11 +20,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -54,9 +56,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -70,7 +72,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -86,9 +88,9 @@ ___
___
#### releaseLock
### releaseLock
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBReader.mdx
+10 -8
View File
@@ -22,13 +22,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -58,11 +60,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### read
### read
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -76,7 +78,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -92,11 +94,11 @@ ___
___
#### releaseLock
### releaseLock
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx
+8 -6
View File
@@ -22,13 +22,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### respond
### respond
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +44,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -58,11 +60,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### respondWithNewView
### respondWithNewView
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -76,7 +78,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultController-1.mdx
+10 -8
View File
@@ -34,11 +34,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### close
### close
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -54,9 +56,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### enqueue
### enqueue
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -70,7 +72,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -86,9 +88,9 @@ ___
___
#### error
### error
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -102,7 +104,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultController.mdx
+10 -8
View File
@@ -36,13 +36,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### close
### close
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -58,11 +60,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### enqueue
### enqueue
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -76,7 +78,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -92,11 +94,11 @@ ___
___
#### error
### error
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -110,7 +112,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultReader-1.mdx
+9 -7
View File
@@ -34,11 +34,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -52,7 +54,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -68,9 +70,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### read
### read
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -86,9 +88,9 @@ ___
___
#### releaseLock
### releaseLock
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultReader.mdx
+9 -7
View File
@@ -36,13 +36,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,11 +74,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### read
### read
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -92,11 +94,11 @@ ___
___
#### releaseLock
### releaseLock
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamGenericReader-1.mdx
+5 -3
View File
@@ -20,11 +20,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamGenericReader.mdx
+5 -3
View File
@@ -20,13 +20,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### cancel
### cancel
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -40,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.SharedArrayBuffer.mdx
+5 -3
View File
@@ -38,13 +38,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### slice
### slice
Returns a section of an SharedArrayBuffer.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -67,7 +69,7 @@ Returns a section of an SharedArrayBuffer.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.TransformOptions.mdx
+26 -24
View File
@@ -137,11 +137,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### construct
### construct
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -164,7 +166,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -180,9 +182,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### destroy
### destroy
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -214,7 +216,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -230,9 +232,9 @@ ___
___
#### final
### final
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -255,7 +257,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -271,9 +273,9 @@ ___
___
#### flush
### flush
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -296,7 +298,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -312,9 +314,9 @@ ___
___
#### read
### read
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -337,7 +339,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -353,9 +355,9 @@ ___
___
#### transform
### transform
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -396,7 +398,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -412,9 +414,9 @@ ___
___
#### write
### write
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -455,7 +457,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -471,9 +473,9 @@ ___
___
#### writev
### writev
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -505,7 +507,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream-1.mdx
+9 -7
View File
@@ -38,13 +38,15 @@ This Streams API interface provides a standard abstraction for writing streamin
}
]} />
___
## Methods
#### abort
### abort
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -58,7 +60,7 @@ This Streams API interface provides a standard abstraction for writing streamin
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -74,11 +76,11 @@ This Streams API interface provides a standard abstraction for writing streamin
___
#### close
### close
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -94,11 +96,11 @@ ___
___
#### getWriter
### getWriter
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream-2.mdx
+9 -7
View File
@@ -38,11 +38,13 @@ built-in back pressure and queuing.
}
]} />
___
## Methods
#### abort
### abort
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +58,7 @@ built-in back pressure and queuing.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,9 +74,9 @@ built-in back pressure and queuing.
___
#### close
### close
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -90,9 +92,9 @@ ___
___
#### getWriter
### getWriter
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream.mdx
+60 -58
View File
@@ -20,11 +20,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### [captureRejectionSymbol]
### [captureRejectionSymbol]
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -72,11 +74,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
#### addListener
### addListener
Alias for `emitter.on(eventName, listener)`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -99,7 +101,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -119,7 +121,7 @@ v0.1.26
___
#### emit
### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -159,7 +161,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -182,7 +184,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -202,11 +204,11 @@ v0.1.26
___
#### end
### end
`**end**(cb?): [WritableStream](internal.WritableStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -220,7 +222,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -236,7 +238,7 @@ ___
`**end**(data, cb?): [WritableStream](internal.WritableStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -259,7 +261,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -275,7 +277,7 @@ ___
`**end**(str, encoding?, cb?): [WritableStream](internal.WritableStream.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -307,7 +309,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -323,7 +325,7 @@ ___
___
#### eventNames
### eventNames
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 +344,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -362,12 +364,12 @@ v6.0.0
___
#### getMaxListeners
### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -387,13 +389,13 @@ v1.0.0
___
#### listenerCount
### listenerCount
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
in the list of the listeners of the event.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -416,7 +418,7 @@ in the list of the listeners of the event.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -436,7 +438,7 @@ v3.2.0
___
#### listeners
### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -448,7 +450,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -462,7 +464,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -482,11 +484,11 @@ v0.1.26
___
#### off
### off
Alias for `emitter.removeListener()`.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -509,7 +511,7 @@ Alias for `emitter.removeListener()`.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -529,7 +531,7 @@ v10.0.0
___
#### on
### on
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
@@ -558,7 +560,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -581,7 +583,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -601,7 +603,7 @@ v0.1.101
___
#### once
### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -628,7 +630,7 @@ myEE.emit('foo');
// a
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -651,7 +653,7 @@ myEE.emit('foo');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -671,7 +673,7 @@ v0.3.0
___
#### prependListener
### prependListener
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
@@ -686,7 +688,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -709,7 +711,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -729,7 +731,7 @@ v6.0.0
___
#### prependOnceListener
### prependOnceListener
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.
@@ -742,7 +744,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -765,7 +767,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -785,7 +787,7 @@ v6.0.0
___
#### rawListeners
### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -815,7 +817,7 @@ newListeners[0]();
emitter.emit('log');
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -829,7 +831,7 @@ emitter.emit('log');
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -849,7 +851,7 @@ v9.4.0
___
#### removeAllListeners
### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -859,7 +861,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -873,7 +875,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -893,7 +895,7 @@ v0.1.26
___
#### removeListener
### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -975,7 +977,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -998,7 +1000,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1018,7 +1020,7 @@ v0.1.26
___
#### setMaxListeners
### setMaxListeners
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
@@ -1027,7 +1029,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1041,7 +1043,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1061,11 +1063,11 @@ v0.3.5
___
#### write
### write
`**write**(buffer, cb?): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1088,7 +1090,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1104,7 +1106,7 @@ ___
`**write**(str, encoding?, cb?): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1136,7 +1138,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultController-1.mdx
+3 -3
View File
@@ -13,9 +13,9 @@ instance to manipulate.
## Methods
#### error
### error
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -29,7 +29,7 @@ instance to manipulate.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultController.mdx
+5 -3
View File
@@ -24,13 +24,15 @@ This Streams API interface represents a controller allowing control of a Writab
}
]} />
___
## Methods
#### error
### error
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -44,7 +46,7 @@ This Streams API interface represents a controller allowing control of a Writab
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx
+12 -10
View File
@@ -57,11 +57,13 @@ sink.
}
]} />
___
## Methods
#### abort
### abort
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -75,7 +77,7 @@ sink.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -91,9 +93,9 @@ sink.
___
#### close
### close
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -109,9 +111,9 @@ ___
___
#### releaseLock
### releaseLock
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -127,9 +129,9 @@ ___
___
#### write
### write
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -143,7 +145,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter.mdx
+12 -10
View File
@@ -56,13 +56,15 @@ This Streams API interface is the object returned by WritableStream.getWriter()
}
]} />
___
## Methods
#### abort
### abort
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -76,7 +78,7 @@ This Streams API interface is the object returned by WritableStream.getWriter()
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -92,11 +94,11 @@ This Streams API interface is the object returned by WritableStream.getWriter()
___
#### close
### close
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -112,11 +114,11 @@ ___
___
#### releaseLock
### releaseLock
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock)
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -132,11 +134,11 @@ ___
___
#### write
### write
[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -150,7 +152,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal._DOMEventTarget.mdx
+3 -3
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### addEventListener
### addEventListener
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -51,7 +51,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal._NodeEventTarget.mdx
+3 -3
View File
@@ -8,9 +8,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### once
### once
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.FulfillmentService.mdx
+37 -37
View File
@@ -11,11 +11,11 @@ Fullfillment provider plugin services should extend the AbstractFulfillmentServi
## Methods
#### calculatePrice
### calculatePrice
Used to calculate a price for a given shipping option.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ Used to calculate a price for a given shipping option.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -63,11 +63,11 @@ Used to calculate a price for a given shipping option.
___
#### canCalculate
### canCalculate
Used to determine if a shipping option can have a calculated price
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -81,7 +81,7 @@ Used to determine if a shipping option can have a calculated price
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -97,11 +97,11 @@ Used to determine if a shipping option can have a calculated price
___
#### cancelFulfillment
### cancelFulfillment
Cancel a fulfillment using data from the fulfillment
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -115,7 +115,7 @@ Cancel a fulfillment using data from the fulfillment
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -131,12 +131,12 @@ Cancel a fulfillment using data from the fulfillment
___
#### createFulfillment
### createFulfillment
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.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -177,7 +177,7 @@ The returned value of this method will populate the `fulfillment.data` field.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -193,13 +193,13 @@ The returned value of this method will populate the `fulfillment.data` field.
___
#### createReturn
### createReturn
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
documents attached to the return.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -213,7 +213,7 @@ documents attached to the return.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -229,11 +229,11 @@ documents attached to the return.
___
#### getFulfillmentDocuments
### getFulfillmentDocuments
Used to retrieve documents associated with a fulfillment.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -247,7 +247,7 @@ Used to retrieve documents associated with a fulfillment.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -263,7 +263,7 @@ Used to retrieve documents associated with a fulfillment.
___
#### getFulfillmentOptions
### getFulfillmentOptions
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,
@@ -272,7 +272,7 @@ enforced. For example, a fulfillment provider may offer Standard Shipping
and Express Shipping as fulfillment options, it is up to the store operator
to create shipping options in Medusa that are offered to the customer.
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -288,11 +288,11 @@ to create shipping options in Medusa that are offered to the customer.
___
#### getIdentifier
### getIdentifier
Return a unique identifier to retrieve the fulfillment plugin provider
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -308,11 +308,11 @@ Return a unique identifier to retrieve the fulfillment plugin provider
___
#### getReturnDocuments
### getReturnDocuments
Used to retrieve documents related to a return order.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -326,7 +326,7 @@ Used to retrieve documents related to a return order.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -342,11 +342,11 @@ Used to retrieve documents related to a return order.
___
#### getShipmentDocuments
### getShipmentDocuments
Used to retrieve documents related to a shipment.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -360,7 +360,7 @@ Used to retrieve documents related to a shipment.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -376,9 +376,9 @@ Used to retrieve documents related to a shipment.
___
#### retrieveDocuments
### retrieveDocuments
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -401,7 +401,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -417,7 +417,7 @@ ___
___
#### validateFulfillmentData
### validateFulfillmentData
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
@@ -425,7 +425,7 @@ data about the shipment such as an id of a drop point. It is up to the
fulfillment provider to enforce that the correct data is being sent
through.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -457,7 +457,7 @@ through.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -473,12 +473,12 @@ through.
___
#### validateOption
### validateOption
Called before a shipping option is created in Admin. Use this to ensure
that a fulfillment option does in fact exist.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -492,7 +492,7 @@ that a fulfillment option does in fact exist.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IBatchJobStrategy.mdx
+37 -23
View File
@@ -56,23 +56,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
#### Inherited from
#### Returns
[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_)
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -104,7 +118,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -120,11 +134,11 @@ transaction manager is created.
___
#### buildTemplate
### buildTemplate
Builds and returns a template file that can be downloaded and filled in
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -140,11 +154,11 @@ Builds and returns a template file that can be downloaded and filled in
___
#### preProcessBatchJob
### preProcessBatchJob
Method for pre-processing a batch job
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -158,7 +172,7 @@ Method for pre-processing a batch job
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -174,11 +188,11 @@ Method for pre-processing a batch job
___
#### prepareBatchJobForProcessing
### prepareBatchJobForProcessing
Method for preparing a batch job for processing
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -201,7 +215,7 @@ Method for preparing a batch job for processing
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -217,11 +231,11 @@ Method for preparing a batch job for processing
___
#### processJob
### processJob
Method does the actual processing of the job. Should report back on the progress of the operation.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -235,7 +249,7 @@ Method does the actual processing of the job. Should report back on the progress
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -251,9 +265,9 @@ Method does the actual processing of the job. Should report back on the progress
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -267,7 +281,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -283,9 +297,9 @@ ___
___
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -299,7 +313,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.ICartCompletionStrategy.mdx
+3 -3
View File
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### complete
### complete
Takes a cart id and completes the cart. This for example takes place when
creating an order or confirming a swap.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ creating an order or confirming a swap.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IFileService.mdx
+44 -30
View File
@@ -56,23 +56,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
#### Inherited from
#### Returns
[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_)
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -104,7 +118,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -120,11 +134,11 @@ transaction manager is created.
___
#### delete
### delete
remove file from fileservice
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -138,7 +152,7 @@ remove file from fileservice
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -154,11 +168,11 @@ remove file from fileservice
___
#### getDownloadStream
### getDownloadStream
download file from fileservice as stream
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +186,7 @@ download file from fileservice as stream
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -188,11 +202,11 @@ download file from fileservice as stream
___
#### getPresignedDownloadUrl
### getPresignedDownloadUrl
Generate a presigned download url to obtain a file
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -206,7 +220,7 @@ Generate a presigned download url to obtain a file
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -222,11 +236,11 @@ Generate a presigned download url to obtain a file
___
#### getUploadStreamDescriptor
### getUploadStreamDescriptor
upload file to fileservice from stream
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -240,7 +254,7 @@ upload file to fileservice from stream
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -256,9 +270,9 @@ upload file to fileservice from stream
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -272,7 +286,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -288,11 +302,11 @@ ___
___
#### upload
### upload
upload file to fileservice
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -306,7 +320,7 @@ upload file to fileservice
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -322,11 +336,11 @@ upload file to fileservice
___
#### uploadProtected
### uploadProtected
upload private file to fileservice
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -340,7 +354,7 @@ upload private file to fileservice
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -356,9 +370,9 @@ upload private file to fileservice
___
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +386,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.INotificationService.mdx
+32 -18
View File
@@ -56,23 +56,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
#### Inherited from
#### Returns
[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_)
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -104,7 +118,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -120,9 +134,9 @@ transaction manager is created.
___
#### resendNotification
### resendNotification
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -154,7 +168,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -170,9 +184,9 @@ ___
___
#### sendNotification
### sendNotification
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -204,7 +218,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -220,9 +234,9 @@ ___
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -236,7 +250,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -252,9 +266,9 @@ ___
___
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -268,7 +282,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IPriceSelectionStrategy.mdx
+9 -9
View File
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### calculateVariantPrice
### calculateVariantPrice
Calculate the original and discount price for a given variant in a set of
circumstances described in the context.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -36,7 +36,7 @@ circumstances described in the context.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -52,11 +52,11 @@ circumstances described in the context.
___
#### onVariantsPricesUpdate
### onVariantsPricesUpdate
Notify price selection strategy that variants prices have been updated.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -70,7 +70,7 @@ Notify price selection strategy that variants prices have been updated.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -86,9 +86,9 @@ Notify price selection strategy that variants prices have been updated.
___
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -102,7 +102,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.ITaxCalculationStrategy.mdx
+3 -3
View File
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
#### calculate
### calculate
Calculates the tax amount for a given set of line items under applicable
tax conditions and calculation contexts.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ tax conditions and calculation contexts.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.ITaxService.mdx
+3 -3
View File
@@ -12,11 +12,11 @@ items and shipping methods.
## Methods
#### getTaxLines
### getTaxLines
Retrieves the numerical tax lines for a calculation context.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -48,7 +48,7 @@ Retrieves the numerical tax lines for a calculation context.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.MedusaRequest.mdx
+238 -236
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.PaymentProcessor.mdx
+32 -32
View File
@@ -11,11 +11,11 @@ This work is still experimental and can be changed until it becomes stable
## Methods
#### authorizePayment
### authorizePayment
Authorize an existing session if it is not already authorized
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +38,7 @@ Authorize an existing session if it is not already authorized
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -54,11 +54,11 @@ Authorize an existing session if it is not already authorized
___
#### cancelPayment
### cancelPayment
Cancel an existing session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -72,7 +72,7 @@ Cancel an existing session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -88,11 +88,11 @@ Cancel an existing session
___
#### capturePayment
### capturePayment
Capture an existing session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -106,7 +106,7 @@ Capture an existing session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -122,11 +122,11 @@ Capture an existing session
___
#### deletePayment
### deletePayment
Delete an existing session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -140,7 +140,7 @@ Delete an existing session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -156,11 +156,11 @@ Delete an existing session
___
#### getIdentifier
### getIdentifier
Return a unique identifier to retrieve the payment plugin provider
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -176,11 +176,11 @@ Return a unique identifier to retrieve the payment plugin provider
___
#### getPaymentStatus
### getPaymentStatus
Return the status of the session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -194,7 +194,7 @@ Return the status of the session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -210,11 +210,11 @@ Return the status of the session
___
#### initiatePayment
### initiatePayment
Initiate a payment session with the external provider
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -228,7 +228,7 @@ Initiate a payment session with the external provider
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -244,11 +244,11 @@ Initiate a payment session with the external provider
___
#### refundPayment
### refundPayment
Refund an existing session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -271,7 +271,7 @@ Refund an existing session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -287,11 +287,11 @@ Refund an existing session
___
#### retrievePayment
### retrievePayment
Retrieve an existing session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -305,7 +305,7 @@ Retrieve an existing session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -321,11 +321,11 @@ Retrieve an existing session
___
#### updatePayment
### updatePayment
Update an existing payment session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -339,7 +339,7 @@ Update an existing payment session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -355,11 +355,11 @@ Update an existing payment session
___
#### updatePaymentData
### updatePaymentData
Update the session data for a payment session
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -382,7 +382,7 @@ Update the session data for a payment session
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.PaymentService.mdx
+69 -55
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This will be
#### Deprecated
## Deprecated
in the near future use the new PaymentProcessor interface instead
@@ -62,23 +62,37 @@ in the near future use the new PaymentProcessor interface instead
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
#### Inherited from
#### Returns
[TransactionBaseService](../classes/internal.internal.TransactionBaseService.mdx).[activeManager_](../classes/internal.internal.TransactionBaseService.mdx#activemanager_)
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### atomicPhase\_
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -110,7 +124,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -126,11 +140,11 @@ transaction manager is created.
___
#### authorizePayment
### authorizePayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -153,7 +167,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -173,11 +187,11 @@ in the near future use PaymentProcessor.authorizePayment instead
___
#### cancelPayment
### cancelPayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -191,7 +205,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -211,11 +225,11 @@ in the near future use PaymentProcessor.cancelPayment instead
___
#### capturePayment
### capturePayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -229,7 +243,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -249,13 +263,13 @@ in the near future use PaymentProcessor.capturePayment instead
___
#### createPayment
### createPayment
`**createPayment**(context): Promise&#60;[PaymentSessionResponse](../types/internal.internal.PaymentSessionResponse.mdx)&#62;`
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -269,7 +283,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -291,7 +305,7 @@ in the near future use PaymentProcessor.initiatePayment instead
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -305,7 +319,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -325,11 +339,11 @@ in the near future use createPayment(context: `Cart & PaymentContext): Promise<P
___
#### deletePayment
### deletePayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -343,7 +357,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -363,9 +377,9 @@ in the near future use PaymentProcessor.cancelPayment instead
___
#### getIdentifier
### getIdentifier
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -381,11 +395,11 @@ ___
___
#### getPaymentData
### getPaymentData
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -399,7 +413,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -419,11 +433,11 @@ in the near future use PaymentProcessor.retrievePayment instead
___
#### getStatus
### getStatus
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -437,7 +451,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -457,11 +471,11 @@ in the near future use PaymentProcessor.getPaymentStatus instead
___
#### refundPayment
### refundPayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -484,7 +498,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -504,11 +518,11 @@ in the near future use PaymentProcessor.refundPayment instead
___
#### retrievePayment
### retrievePayment
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -522,7 +536,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -542,11 +556,11 @@ in the near future use PaymentProcessor.retrievePayment instead
___
#### retrieveSavedMethods
### retrieveSavedMethods
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -560,7 +574,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -580,9 +594,9 @@ in the near future use PaymentProcessor.getSavedMethods instead
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -596,7 +610,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -612,11 +626,11 @@ ___
___
#### updatePayment
### updatePayment
`**updatePayment**(paymentSessionData, context): Promise&#60;[Data](../types/internal.internal.Data.mdx) \| [PaymentSessionResponse](../types/internal.internal.PaymentSessionResponse.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -639,7 +653,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -657,7 +671,7 @@ ___
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -680,7 +694,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -700,11 +714,11 @@ in the near future use PaymentProcessor.updatePayment instead
___
#### updatePaymentData
### updatePaymentData
This will be
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -727,7 +741,7 @@ This will be
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -747,9 +761,9 @@ in the near future use PaymentProcessor.updatePayment instead
___
#### withTransaction
### withTransaction
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -763,7 +777,7 @@ ___
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{