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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal/interfaces/internal.ArrayBufferView.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "buffer",
"type": "[`ArrayBufferLike`](../types/internal.ArrayBufferLike.mdx)",
"type": "[ArrayBufferLike](../types/internal.ArrayBufferLike.mdx)",
"description": "The ArrayBuffer instance referenced by the array.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ArrayLike.mdx
-4
View File
@@ -20,10 +20,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
## Indexable
▪ [n: `number`]: `T`
## Properties
<ParameterTypes parameters={[
www/apps/docs/content/references/js-client/internal/interfaces/internal.ArrayOptions.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "allows destroying the stream if the signal is aborted.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncGenerator.mdx
+5 -5
View File
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "AsyncGenerator",
"type": "[`AsyncGenerator`](internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\\>",
"type": "[AsyncGenerator](internal.AsyncGenerator.mdx)&#60;T, TReturn, TNext&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -79,7 +79,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -97,7 +97,7 @@ ___
<ParameterTypes parameters={[
{
"name": "value",
"type": "`TReturn` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TReturn`\\>",
"type": "`TReturn` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TReturn&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -143,7 +143,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncGeneratorFunction.mdx
+1 -35
View File
@@ -6,40 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AsyncGeneratorFunction
## Callable
### AsyncGeneratorFunction
Creates a new AsyncGenerator object.
#### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`any`[]",
"description": "A list of arguments the function accepts.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AsyncGenerator",
"type": "[`AsyncGenerator`](internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
## Properties
<ParameterTypes parameters={[
@@ -63,7 +29,7 @@ Creates a new AsyncGenerator object.
},
{
"name": "prototype",
"type": "[`AsyncGenerator`](internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\\>",
"type": "[AsyncGenerator](internal.AsyncGenerator.mdx)&#60;unknown, any, unknown&#62;",
"description": "A reference to the prototype.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterable.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "AsyncIterator",
"type": "[`AsyncIterator`](internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\\>",
"type": "[AsyncIterator](internal.AsyncIterator.mdx)&#60;T, any, undefined&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterableIterator.mdx
+4 -4
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "AsyncIterableIterator",
"type": "[`AsyncIterableIterator`](internal.AsyncIterableIterator.mdx)<`T`\\>",
"type": "[AsyncIterableIterator](internal.AsyncIterableIterator.mdx)&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -61,7 +61,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -93,7 +93,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -125,7 +125,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AsyncIterator.mdx
+4 -4
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -79,7 +79,7 @@ ___
<ParameterTypes parameters={[
{
"name": "value",
"type": "`TReturn` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TReturn`\\>",
"type": "`TReturn` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TReturn&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -93,7 +93,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -125,7 +125,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>\\>",
"type": "Promise&#60;[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosAdapter.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# AxiosAdapter
## Callable
### AxiosAdapter
#### Parameters
<ParameterTypes parameters={[
{
"name": "config",
"type": "`AxiosRequestConfig`<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AxiosPromise",
"type": "[`AxiosPromise`](internal.AxiosPromise.mdx)<`any`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosDefaults.mdx
+12 -12
View File
@@ -27,7 +27,7 @@ Construct a type with the properties of T except for those in type K.
<ParameterTypes parameters={[
{
"name": "adapter",
"type": "[`AxiosAdapter`](internal.AxiosAdapter.mdx)",
"type": "[AxiosAdapter](internal.AxiosAdapter.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -36,7 +36,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "auth",
"type": "[`AxiosBasicCredentials`](internal.AxiosBasicCredentials.mdx)",
"type": "[AxiosBasicCredentials](internal.AxiosBasicCredentials.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -54,7 +54,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "cancelToken",
"type": "[`CancelToken`](internal.CancelToken.mdx)",
"type": "[CancelToken](internal.CancelToken.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -81,7 +81,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "headers",
"type": "[`HeadersDefaults`](internal.HeadersDefaults.mdx)",
"type": "[HeadersDefaults](internal.HeadersDefaults.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -144,7 +144,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "method",
"type": "[`Method`](../types/internal.Method.mdx)",
"type": "[Method](../types/internal.Method.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -189,7 +189,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "proxy",
"type": "``false`` \\| [`AxiosProxyConfig`](internal.AxiosProxyConfig.mdx)",
"type": "``false`` \\| [AxiosProxyConfig](internal.AxiosProxyConfig.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -198,7 +198,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "raxConfig",
"type": "[`RetryConfig`](internal.RetryConfig.mdx)",
"type": "[RetryConfig](internal.RetryConfig.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -207,7 +207,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "responseType",
"type": "[`ResponseType`](../types/internal.ResponseType.mdx)",
"type": "[ResponseType](../types/internal.ResponseType.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -216,7 +216,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
@@ -252,7 +252,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "transformRequest",
"type": "[`AxiosRequestTransformer`](internal.AxiosRequestTransformer.mdx) \\| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.mdx)[]",
"type": "[AxiosRequestTransformer](internal.AxiosRequestTransformer.mdx) \\| [AxiosRequestTransformer](internal.AxiosRequestTransformer.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -261,7 +261,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "transformResponse",
"type": "[`AxiosResponseTransformer`](internal.AxiosResponseTransformer.mdx) \\| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.mdx)[]",
"type": "[AxiosResponseTransformer](internal.AxiosResponseTransformer.mdx) \\| [AxiosResponseTransformer](internal.AxiosResponseTransformer.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -270,7 +270,7 @@ Construct a type with the properties of T except for those in type K.
},
{
"name": "transitional",
"type": "[`TransitionalOptions`](internal.TransitionalOptions.mdx)",
"type": "[TransitionalOptions](internal.TransitionalOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosError.mdx
+2 -2
View File
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -88,7 +88,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "response",
"type": "[`AxiosResponse`](internal.AxiosResponse.mdx)<`T`, `D`\\>",
"type": "[AxiosResponse](internal.AxiosResponse.mdx)&#60;T, D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosInstance.mdx
+20 -95
View File
@@ -6,87 +6,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AxiosInstance
## Callable
### AxiosInstance
**AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.mdx)<`any`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "config",
"type": "`AxiosRequestConfig`<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AxiosPromise",
"type": "[`AxiosPromise`](internal.AxiosPromise.mdx)<`any`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
### AxiosInstance
**AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.mdx)<`any`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "url",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`any`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AxiosPromise",
"type": "[`AxiosPromise`](internal.AxiosPromise.mdx)<`any`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "defaults",
"type": "[`AxiosDefaults`](internal.AxiosDefaults.mdx)<`any`\\>",
"type": "[AxiosDefaults](internal.AxiosDefaults.mdx)&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -104,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "interceptors.request",
"type": "[`AxiosInterceptorManager`](internal.AxiosInterceptorManager.mdx)<`AxiosRequestConfig`<`any`\\>\\>",
"type": "[AxiosInterceptorManager](internal.AxiosInterceptorManager.mdx)&#60;AxiosRequestConfig&#60;any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -113,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "interceptors.response",
"type": "[`AxiosInterceptorManager`](internal.AxiosInterceptorManager.mdx)<[`AxiosResponse`](internal.AxiosResponse.mdx)<`any`, `any`\\>\\>",
"type": "[AxiosInterceptorManager](internal.AxiosInterceptorManager.mdx)&#60;[AxiosResponse](internal.AxiosResponse.mdx)&#60;any, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -140,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -154,7 +79,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -181,7 +106,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -195,7 +120,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -213,7 +138,7 @@ ___
<ParameterTypes parameters={[
{
"name": "config",
"type": "`AxiosRequestConfig`<`any`\\>",
"type": "AxiosRequestConfig&#60;any&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -254,7 +179,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -268,7 +193,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -295,7 +220,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -309,7 +234,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -345,7 +270,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -359,7 +284,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -395,7 +320,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -409,7 +334,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -445,7 +370,7 @@ ___
},
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -459,7 +384,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -477,7 +402,7 @@ ___
<ParameterTypes parameters={[
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -491,7 +416,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`R`\\>",
"type": "Promise&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosInterceptorManager.mdx
+1 -1
View File
@@ -61,7 +61,7 @@ ___
<ParameterTypes parameters={[
{
"name": "onFulfilled",
"type": "(`value`: `V`) => `T` \\| `Promise`<`T`\\>",
"type": "(`value`: `V`) => `T` \\| Promise&#60;T&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx
+6 -6
View File
@@ -45,7 +45,7 @@ Attaches a callback for only the rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "onrejected",
"type": "``null`` \\| (`reason`: `any`) => `TResult` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TResult`\\>",
"type": "``null`` \\| (`reason`: `any`) => `TResult` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TResult&#62;",
"description": "The callback to execute when the Promise is rejected.",
"optional": true,
"defaultValue": "",
@@ -59,7 +59,7 @@ Attaches a callback for only the rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AxiosResponse`](internal.AxiosResponse.mdx)<`T`, `any`\\> \\| `TResult`\\>",
"type": "Promise&#60;[AxiosResponse](internal.AxiosResponse.mdx)&#60;T, any&#62; \\| TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "A Promise for the completion of the callback.",
@@ -94,7 +94,7 @@ resolved value cannot be modified from the callback.
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AxiosResponse`](internal.AxiosResponse.mdx)<`T`, `any`\\>\\>",
"type": "Promise&#60;[AxiosResponse](internal.AxiosResponse.mdx)&#60;T, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "A Promise for the completion of the callback.",
@@ -114,7 +114,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "onfulfilled",
"type": "``null`` \\| (`value`: [`AxiosResponse`](internal.AxiosResponse.mdx)<`T`, `any`\\>) => `TResult1` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TResult1`\\>",
"type": "``null`` \\| (`value`: [AxiosResponse](internal.AxiosResponse.mdx)&#60;T, any&#62;) => `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TResult1&#62;",
"description": "The callback to execute when the Promise is resolved.",
"optional": true,
"defaultValue": "",
@@ -123,7 +123,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
},
{
"name": "onrejected",
"type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TResult2`\\>",
"type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TResult2&#62;",
"description": "The callback to execute when the Promise is rejected.",
"optional": true,
"defaultValue": "",
@@ -137,7 +137,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult1` \\| `TResult2`\\>",
"type": "Promise&#60;TResult1 \\| TResult2&#62;",
"optional": false,
"defaultValue": "",
"description": "A Promise for the completion of which ever callback is executed.",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosRequestTransformer.mdx
-41
View File
@@ -5,44 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# AxiosRequestTransformer
## Callable
### AxiosRequestTransformer
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "headers",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosResponse.mdx
+2 -2
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "config",
"type": "`AxiosRequestConfig`<`D`\\>",
"type": "AxiosRequestConfig&#60;D&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -52,7 +52,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "headers",
"type": "[`AxiosResponseHeaders`](../types/internal.AxiosResponseHeaders.mdx)",
"type": "[AxiosResponseHeaders](../types/internal.AxiosResponseHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosResponseTransformer.mdx
-41
View File
@@ -5,44 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# AxiosResponseTransformer
## Callable
### AxiosResponseTransformer
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "headers",
"type": "[`AxiosResponseHeaders`](../types/internal.AxiosResponseHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.BaseRepositoryService.mdx
+3 -3
View File
@@ -72,7 +72,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TOutput`\\>",
"type": "Promise&#60;TOutput&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -90,7 +90,7 @@ ___
<ParameterTypes parameters={[
{
"name": "task",
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
"type": "(`transactionManager`: `TManager`) => Promise&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -140,7 +140,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`any`\\>",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.BlobOptions.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.BlobPropertyBag.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "endings",
"type": "[`EndingType`](../types/internal.EndingType.mdx)",
"type": "[EndingType](../types/internal.EndingType.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx
+71 -71
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "buffer",
"type": "[`ArrayBufferLike`](../types/internal.ArrayBufferLike.mdx)",
"type": "[ArrayBufferLike](../types/internal.ArrayBufferLike.mdx)",
"description": "The ArrayBuffer instance referenced by the array.",
"optional": false,
"defaultValue": "",
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](internal.IterableIterator.mdx)<`number`\\>",
"type": "[IterableIterator](internal.IterableIterator.mdx)&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -127,8 +127,8 @@ Compares `buf` with `target` and returns a number indicating whether `buf`comes
Comparison is based on the actual sequence of bytes in each `Buffer`.
* `0` is returned if `target` is the same as `buf`
* `1` is returned if `target` should come _before_`buf` when sorted.
* `-1` is returned if `target` should come _after_`buf` when sorted.
* `1` is returned if `target` should come \_before\_`buf` when sorted.
* `-1` is returned if `target` should come \_after\_`buf` when sorted.
```js
import { Buffer } from 'node:buffer';
@@ -175,7 +175,7 @@ console.log(buf1.compare(buf2, 5, 6, 5));
<ParameterTypes parameters={[
{
"name": "target",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "A `Buffer` or Uint8Array with which to compare `buf`.",
"optional": false,
"defaultValue": "",
@@ -224,7 +224,7 @@ console.log(buf1.compare(buf2, 5, 6, 5));
<ParameterTypes parameters={[
{
"name": "``0`` \\| ``1`` \\| ``-1``",
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"optional": true,
"defaultValue": "",
@@ -244,7 +244,7 @@ ___
Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`.
[`TypedArray.prototype.set()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set) performs the same operation, and is available
[`TypedArray.prototype.set()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/TypedArray/set) performs the same operation, and is available
for all TypedArrays, including Node.js `Buffer`s, although it takes
different function arguments.
@@ -293,7 +293,7 @@ console.log(buf.toString());
<ParameterTypes parameters={[
{
"name": "target",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "A `Buffer` or Uint8Array to copy into.",
"optional": false,
"defaultValue": "",
@@ -391,7 +391,7 @@ to the same array starting at position target
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -404,7 +404,7 @@ ___
### entries
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration\_protocols) of `[index, byte]` pairs from the contents
of `buf`.
```js
@@ -431,7 +431,7 @@ for (const pair of buf.entries()) {
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](internal.IterableIterator.mdx)<[`number`, `number`]\\>",
"type": "[IterableIterator](internal.IterableIterator.mdx)&#60;[number, number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -468,7 +468,7 @@ console.log(buf1.equals(buf3));
<ParameterTypes parameters={[
{
"name": "otherBuffer",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "A `Buffer` or Uint8Array with which to compare `buf`.",
"optional": false,
"defaultValue": "",
@@ -506,7 +506,7 @@ Determines whether all the members of an array satisfy the specified test.
<ParameterTypes parameters={[
{
"name": "predicate",
"type": "(`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `unknown`",
"type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `unknown`",
"description": "A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ console.log(buf.fill('zz', 'hex'));
<ParameterTypes parameters={[
{
"name": "value",
"type": "`string` \\| `number` \\| `Uint8Array`",
"type": "`string` \\| `number` \\| Uint8Array",
"description": "The value with which to fill `buf`. Empty value (string, Uint8Array, Buffer) is coerced to `0`.",
"optional": false,
"defaultValue": "",
@@ -626,7 +626,7 @@ console.log(buf.fill('zz', 'hex'));
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "The encoding for `value` if `value` is a string.",
"optional": true,
"defaultValue": "",
@@ -640,7 +640,7 @@ console.log(buf.fill('zz', 'hex'));
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "A reference to `buf`.",
@@ -664,7 +664,7 @@ Returns the elements of an array that meet the condition specified in a callback
<ParameterTypes parameters={[
{
"name": "predicate",
"type": "(`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `any`",
"type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `any`",
"description": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -687,7 +687,7 @@ Returns the elements of an array that meet the condition specified in a callback
<ParameterTypes parameters={[
{
"name": "Uint8Array",
"type": "`Uint8Array`",
"type": "Uint8Array",
"optional": false,
"defaultValue": "",
"description": "",
@@ -708,7 +708,7 @@ otherwise.
<ParameterTypes parameters={[
{
"name": "predicate",
"type": "(`value`: `number`, `index`: `number`, `obj`: `Uint8Array`) => `boolean`",
"type": "(`value`: `number`, `index`: `number`, `obj`: Uint8Array) => `boolean`",
"description": "find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,7 @@ otherwise.
<ParameterTypes parameters={[
{
"name": "predicate",
"type": "(`value`: `number`, `index`: `number`, `obj`: `Uint8Array`) => `boolean`",
"type": "(`value`: `number`, `index`: `number`, `obj`: Uint8Array) => `boolean`",
"description": "find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.",
"optional": false,
"defaultValue": "",
@@ -795,7 +795,7 @@ Performs the specified action for each element in an array.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `void`",
"type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `void`",
"description": "A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -859,7 +859,7 @@ console.log(buf.includes('this', 4));
<ParameterTypes parameters={[
{
"name": "value",
"type": "`string` \\| `number` \\| [`Buffer`](../../modules/internal.mdx#buffer)",
"type": "`string` \\| `number` \\| [Buffer](../../modules/internal.mdx#buffer)",
"description": "What to search for.",
"optional": false,
"defaultValue": "",
@@ -877,7 +877,7 @@ console.log(buf.includes('this', 4));
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "If `value` is a string, this is its encoding.",
"optional": true,
"defaultValue": "",
@@ -911,7 +911,7 @@ ___
If `value` is:
* a string, `value` is interpreted according to the character encoding in`encoding`.
* a `Buffer` or [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), `value` will be used in its entirety.
* a `Buffer` or [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Uint8Array), `value` will be used in its entirety.
To compare a partial `Buffer`, use `buf.subarray`.
* a number, `value` will be interpreted as an unsigned 8-bit integer
value between `0` and `255`.
@@ -947,7 +947,7 @@ an integer between 0 and 255.
If `byteOffset` is not a number, it will be coerced to a number. If the result
of coercion is `NaN` or `0`, then the entire buffer will be searched. This
behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf).
behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/String/indexOf).
```js
import { Buffer } from 'node:buffer';
@@ -975,7 +975,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOf
<ParameterTypes parameters={[
{
"name": "value",
"type": "`string` \\| `number` \\| `Uint8Array`",
"type": "`string` \\| `number` \\| Uint8Array",
"description": "What to search for.",
"optional": false,
"defaultValue": "",
@@ -993,7 +993,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOf
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`.",
"optional": true,
"defaultValue": "",
@@ -1058,7 +1058,7 @@ ___
### keys
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices).
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration\_protocols) of `buf` keys (indices).
```js
import { Buffer } from 'node:buffer';
@@ -1082,7 +1082,7 @@ for (const key of buf.keys()) {
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](internal.IterableIterator.mdx)<`number`\\>",
"type": "[IterableIterator](internal.IterableIterator.mdx)&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1135,7 +1135,7 @@ an integer between 0 and 255.
If `byteOffset` is not a number, it will be coerced to a number. Any arguments
that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer.
This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf).
This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/String/lastIndexOf).
```js
import { Buffer } from 'node:buffer';
@@ -1165,7 +1165,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
<ParameterTypes parameters={[
{
"name": "value",
"type": "`string` \\| `number` \\| `Uint8Array`",
"type": "`string` \\| `number` \\| Uint8Array",
"description": "What to search for.",
"optional": false,
"defaultValue": "",
@@ -1183,7 +1183,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`.",
"optional": true,
"defaultValue": "",
@@ -1222,7 +1222,7 @@ contains the results.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `number`",
"type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `number`",
"description": "A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -1245,7 +1245,7 @@ contains the results.
<ParameterTypes parameters={[
{
"name": "Uint8Array",
"type": "`Uint8Array`",
"type": "Uint8Array",
"optional": false,
"defaultValue": "",
"description": "",
@@ -2756,7 +2756,7 @@ ___
### reduce
**reduce**(`callbackfn`): `number`
`**reduce**(callbackfn): number`
Calls the specified callback function for all the elements in an array. The return value of
the callback function is the accumulated result, and is provided as an argument in the next
@@ -2767,7 +2767,7 @@ call to the callback function.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number`",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`",
"description": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -2790,14 +2790,14 @@ call to the callback function.
}
]} />
**reduce**(`callbackfn`, `initialValue`): `number`
`**reduce**(callbackfn, initialValue): number`
#### Parameters
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number`",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2829,7 +2829,7 @@ call to the callback function.
}
]} />
**reduce**<`U`\>(`callbackfn`, `initialValue`): `U`
`**reduce**<TypeParameter U>(callbackfn, initialValue): U`
Calls the specified callback function for all the elements in an array. The return value of
the callback function is the accumulated result, and is provided as an argument in the next
@@ -2840,7 +2840,7 @@ call to the callback function.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `U`",
"type": "(`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `U`",
"description": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -2866,7 +2866,7 @@ ___
### reduceRight
**reduceRight**(`callbackfn`): `number`
`**reduceRight**(callbackfn): number`
Calls the specified callback function for all the elements in an array, in descending order.
The return value of the callback function is the accumulated result, and is provided as an
@@ -2877,7 +2877,7 @@ argument in the next call to the callback function.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number`",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`",
"description": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -2900,14 +2900,14 @@ argument in the next call to the callback function.
}
]} />
**reduceRight**(`callbackfn`, `initialValue`): `number`
`**reduceRight**(callbackfn, initialValue): number`
#### Parameters
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number`",
"type": "(`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `number`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2939,7 +2939,7 @@ argument in the next call to the callback function.
}
]} />
**reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U`
`**reduceRight**<TypeParameter U>(callbackfn, initialValue): U`
Calls the specified callback function for all the elements in an array, in descending order.
The return value of the callback function is the accumulated result, and is provided as an
@@ -2950,7 +2950,7 @@ argument in the next call to the callback function.
<ParameterTypes parameters={[
{
"name": "callbackfn",
"type": "(`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `U`",
"type": "(`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: Uint8Array) => `U`",
"description": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
"optional": false,
"defaultValue": "",
@@ -2981,7 +2981,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3001,7 +3001,7 @@ Sets a value or an array of values.
<ParameterTypes parameters={[
{
"name": "array",
"type": "[`ArrayLike`](internal.ArrayLike.mdx)<`number`\\>",
"type": "[ArrayLike](internal.ArrayLike.mdx)&#60;number&#62;",
"description": "A typed or untyped array of values to set.",
"optional": false,
"defaultValue": "",
@@ -3093,7 +3093,7 @@ console.log(buf.toString());
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3121,7 +3121,7 @@ Determines whether the specified callback function returns true for any element
<ParameterTypes parameters={[
{
"name": "predicate",
"type": "(`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `unknown`",
"type": "(`value`: `number`, `index`: `number`, `array`: Uint8Array) => `unknown`",
"description": "A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.",
"optional": false,
"defaultValue": "",
@@ -3178,7 +3178,7 @@ Sorts an array.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3197,7 +3197,7 @@ offset and cropped by the `start` and `end` indices.
Specifying `end` greater than `buf.length` will return the same result as
that of `end` equal to `buf.length`.
This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray).
This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/TypedArray/subarray).
Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap.
@@ -3274,7 +3274,7 @@ console.log(buf.subarray(-5, -2).toString());
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3292,7 +3292,7 @@ ___
### swap16
Interprets `buf` as an array of unsigned 16-bit integers and swaps the
byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2.
byte order \_in-place\_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2.
```js
import { Buffer } from 'node:buffer';
@@ -3328,7 +3328,7 @@ buf.swap16(); // Convert to big-endian UTF-16 text.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "A reference to `buf`.",
@@ -3346,7 +3346,7 @@ ___
### swap32
Interprets `buf` as an array of unsigned 32-bit integers and swaps the
byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
byte order \_in-place\_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
```js
import { Buffer } from 'node:buffer';
@@ -3372,7 +3372,7 @@ buf2.swap32();
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "A reference to `buf`.",
@@ -3389,7 +3389,7 @@ ___
### swap64
Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
Interprets `buf` as an array of 64-bit numbers and swaps byte order \_in-place\_.
Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8.
```js
@@ -3416,7 +3416,7 @@ buf2.swap64();
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "A reference to `buf`.",
@@ -3433,7 +3433,7 @@ ___
### toJSON
Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls
Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/JSON/stringify) implicitly calls
this function when stringifying a `Buffer` instance.
`Buffer.from()` accepts objects in the format returned from this method.
@@ -3462,7 +3462,7 @@ console.log(copy);
<ParameterTypes parameters={[
{
"name": "`object`",
"name": "object",
"type": "`object`",
"optional": true,
"defaultValue": "",
@@ -3559,7 +3559,7 @@ console.log(buf2.toString(undefined, 0, 3));
<ParameterTypes parameters={[
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "The character encoding to use.",
"optional": true,
"defaultValue": "",
@@ -3615,7 +3615,7 @@ Returns the primitive value of the specified object.
<ParameterTypes parameters={[
{
"name": "Uint8Array",
"type": "`Uint8Array`",
"type": "Uint8Array",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3628,7 +3628,7 @@ ___
### values
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is
Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration\_protocols) for `buf` values (bytes). This function is
called automatically when a `Buffer` is used in a `for..of` statement.
```js
@@ -3664,7 +3664,7 @@ for (const value of buf) {
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](internal.IterableIterator.mdx)<`number`\\>",
"type": "[IterableIterator](internal.IterableIterator.mdx)&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -3681,7 +3681,7 @@ ___
### write
**write**(`string`, `encoding?`): `number`
`**write**(string, encoding?): number`
Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did
not contain enough space to fit the entire string, only part of `string` will be
@@ -3719,7 +3719,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "The character encoding of `string`.",
"optional": true,
"defaultValue": "",
@@ -3746,7 +3746,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
v0.1.90
**write**(`string`, `offset`, `encoding?`): `number`
`**write**(string, offset, encoding?): number`
#### Parameters
@@ -3771,7 +3771,7 @@ v0.1.90
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -3794,7 +3794,7 @@ v0.1.90
}
]} />
**write**(`string`, `offset`, `length`, `encoding?`): `number`
`**write**(string, offset, length, encoding?): number`
#### Parameters
@@ -3828,7 +3828,7 @@ v0.1.90
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.BufferConstructor.mdx
+44 -44
View File
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Raw data is stored in instances of the Buffer class.
A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized.
Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\|'base64'\|'base64url'\|'binary'(deprecated)\|'hex'
## Properties
@@ -84,7 +84,7 @@ A `TypeError` will be thrown if `size` is not a number.
},
{
"name": "fill",
"type": "`string` \\| `number` \\| `Uint8Array`",
"type": "`string` \\| `number` \\| Uint8Array",
"description": "A value to pre-fill the new `Buffer` with.",
"optional": true,
"defaultValue": "",
@@ -93,7 +93,7 @@ A `TypeError` will be thrown if `size` is not a number.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "If `fill` is a string, this is its encoding.",
"optional": true,
"defaultValue": "",
@@ -107,7 +107,7 @@ A `TypeError` will be thrown if `size` is not a number.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -126,8 +126,8 @@ ___
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.
The underlying memory for `Buffer` instances created in this way is _not_
_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
The underlying memory for `Buffer` instances created in this way is \_not\_
\_initialized\_. The contents of the newly created `Buffer` are unknown and \_may contain sensitive data\_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
```js
import { Buffer } from 'node:buffer';
@@ -151,7 +151,7 @@ and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize
Use of this pre-allocated internal memory pool is a key difference between
calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less
Specifically, `Buffer.alloc(size, fill)` will \_never\_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`\_will\_ use the internal`Buffer` pool if `size` is less
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.
@@ -175,7 +175,7 @@ additional performance that `Buffer.allocUnsafe()` provides.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -195,8 +195,8 @@ ___
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.
The underlying memory for `Buffer` instances created in this way is _not_
_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `buf.fill(0)` to initialize
The underlying memory for `Buffer` instances created in this way is \_not\_
\_initialized\_. The contents of the newly created `Buffer` are unknown and \_may contain sensitive data\_. Use `buf.fill(0)` to initialize
such `Buffer` instances with zeroes.
When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,
@@ -252,7 +252,7 @@ A `TypeError` will be thrown if `size` is not a number.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -270,7 +270,7 @@ ___
### 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
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
for the encoding that is used to convert the string into bytes.
For `'base64'`, `'base64url'`, and `'hex'`, this function assumes valid input.
@@ -289,16 +289,16 @@ console.log(`${str}: ${str.length} characters, ` +
```
When `string` is a
`Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/-
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.
`Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/-
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
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string` \\| `ArrayBuffer` \\| [`SharedArrayBuffer`](../../modules/internal.mdx#sharedarraybuffer) \\| [`ArrayBufferView`](../types/internal.ArrayBufferView-1.mdx)",
"type": "`string` \\| `ArrayBuffer` \\| [SharedArrayBuffer](../../modules/internal.mdx#sharedarraybuffer) \\| [ArrayBufferView](../types/internal.ArrayBufferView-1.mdx)",
"description": "A value to calculate the length of.",
"optional": false,
"defaultValue": "",
@@ -307,7 +307,7 @@ er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuf
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "If `string` is a string, this is its encoding.",
"optional": true,
"defaultValue": "",
@@ -357,7 +357,7 @@ console.log(arr.sort(Buffer.compare));
<ParameterTypes parameters={[
{
"name": "buf1",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ console.log(arr.sort(Buffer.compare));
},
{
"name": "buf2",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -379,7 +379,7 @@ console.log(arr.sort(Buffer.compare));
<ParameterTypes parameters={[
{
"name": "``0`` \\| ``1`` \\| ``-1``",
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"optional": true,
"defaultValue": "",
@@ -436,7 +436,7 @@ console.log(bufA.length);
<ParameterTypes parameters={[
{
"name": "list",
"type": "readonly `Uint8Array`[]",
"type": "readonly Uint8Array[]",
"description": "List of `Buffer` or Uint8Array instances to concatenate.",
"optional": false,
"defaultValue": "",
@@ -459,7 +459,7 @@ console.log(bufA.length);
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -492,8 +492,8 @@ console.log(buf[1]); // 255
<ParameterTypes parameters={[
{
"name": "view",
"type": "[`TypedArray`](../types/internal.TypedArray.mdx)",
"description": "The {TypedArray} to copy.",
"type": "[TypedArray](../types/internal.TypedArray.mdx)",
"description": "The &#123;TypedArray&#125; to copy.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -524,7 +524,7 @@ console.log(buf[1]); // 255
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -541,7 +541,7 @@ ___
### from
**from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../modules/internal.mdx#buffer)
`**from**(arrayBuffer, byteOffset?, length?): [Buffer](../../modules/internal.mdx#buffer)`
Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
Array entries outside that range will be truncated to fit into it.
@@ -567,7 +567,7 @@ appropriate for `Buffer.from()` variants.
<ParameterTypes parameters={[
{
"name": "arrayBuffer",
"type": "[`WithImplicitCoercion`](../types/internal.WithImplicitCoercion.mdx)<`ArrayBuffer` \\| [`SharedArrayBuffer`](../../modules/internal.mdx#sharedarraybuffer)\\>",
"type": "[WithImplicitCoercion](../types/internal.WithImplicitCoercion.mdx)&#60;ArrayBuffer \\| [SharedArrayBuffer](../../modules/internal.mdx#sharedarraybuffer)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ appropriate for `Buffer.from()` variants.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -612,16 +612,16 @@ appropriate for `Buffer.from()` variants.
v5.10.0
**from**(`data`): [`Buffer`](../../modules/internal.mdx#buffer)
`**from**(data): [Buffer](../../modules/internal.mdx#buffer)`
Creates a new Buffer using the passed {data}
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`Uint8Array` \\| readonly `number`[]",
"type": "Uint8Array \\| readonly `number`[]",
"description": "data to create a new Buffer",
"optional": false,
"defaultValue": "",
@@ -635,7 +635,7 @@ Creates a new Buffer using the passed {data}
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -644,14 +644,14 @@ Creates a new Buffer using the passed {data}
}
]} />
**from**(`data`): [`Buffer`](../../modules/internal.mdx#buffer)
`**from**(data): [Buffer](../../modules/internal.mdx#buffer)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`WithImplicitCoercion`](../types/internal.WithImplicitCoercion.mdx)<`string` \\| `Uint8Array` \\| readonly `number`[]\\>",
"type": "[WithImplicitCoercion](../types/internal.WithImplicitCoercion.mdx)&#60;string \\| Uint8Array \\| readonly number[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -665,7 +665,7 @@ Creates a new Buffer using the passed {data}
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -674,18 +674,18 @@ Creates a new Buffer using the passed {data}
}
]} />
**from**(`str`, `encoding?`): [`Buffer`](../../modules/internal.mdx#buffer)
`**from**(str, encoding?): [Buffer](../../modules/internal.mdx#buffer)`
Creates a new Buffer containing the given JavaScript string {str}.
If provided, the {encoding} parameter identifies the character encoding.
If not provided, {encoding} defaults to 'utf8'.
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
<ParameterTypes parameters={[
{
"name": "str",
"type": "[`WithImplicitCoercion`](../types/internal.WithImplicitCoercion.mdx)<`string`\\> \\| { `[toPrimitive]`: Method [toPrimitive] }",
"type": "[WithImplicitCoercion](../types/internal.WithImplicitCoercion.mdx)&#60;string&#62; \\| `&#123; [toPrimitive]: Method [toPrimitive] &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -694,7 +694,7 @@ If not provided, {encoding} defaults to 'utf8'.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -708,7 +708,7 @@ If not provided, {encoding} defaults to 'utf8'.
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -824,7 +824,7 @@ ___
### of
Creates a new Buffer using the passed {data}
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
@@ -845,7 +845,7 @@ Creates a new Buffer using the passed {data}
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../../modules/internal.mdx#buffer)",
"type": "[Buffer](../../modules/internal.mdx#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.CallSite.mdx
+5 -5
View File
@@ -16,7 +16,7 @@ Current column number [if this function was defined in a script]
<ParameterTypes parameters={[
{
"name": "``null`` \\| number",
"name": "`null` \\| number",
"type": "``null`` \\| `number`",
"optional": true,
"defaultValue": "",
@@ -99,7 +99,7 @@ to infer a name from the function's context.
<ParameterTypes parameters={[
{
"name": "``null`` \\| string",
"name": "`null` \\| string",
"type": "``null`` \\| `string`",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ Current line number [if this function was defined in a script]
<ParameterTypes parameters={[
{
"name": "``null`` \\| number",
"name": "`null` \\| number",
"type": "``null`` \\| `number`",
"optional": true,
"defaultValue": "",
@@ -140,7 +140,7 @@ the current function
<ParameterTypes parameters={[
{
"name": "``null`` \\| string",
"name": "`null` \\| string",
"type": "``null`` \\| `string`",
"optional": true,
"defaultValue": "",
@@ -183,7 +183,7 @@ property.
<ParameterTypes parameters={[
{
"name": "``null`` \\| string",
"name": "`null` \\| string",
"type": "``null`` \\| `string`",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.CancelToken.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "promise",
"type": "`Promise`<[`Cancel`](internal.Cancel.mdx)\\>",
"type": "Promise&#60;[Cancel](internal.Cancel.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "reason",
"type": "[`Cancel`](internal.Cancel.mdx)",
"type": "[Cancel](internal.Cancel.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.Config.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ConnectOpts.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "onread",
"type": "[`OnReadOpts`](internal.OnReadOpts.mdx)",
"type": "[OnReadOpts](internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.CreateNoteInput.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "author",
"type": "[`User`](../classes/internal.User.mdx)",
"type": "[User](../classes/internal.User.mdx)",
"description": "A User is an administrator who can manage store settings and data.",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.CreateUserInput.mdx
+2 -2
View File
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "role",
"type": "[`UserRoles`](../enums/internal.internal.UserRoles.mdx)",
"type": "[UserRoles](../enums/internal.internal.UserRoles.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.Dict.mdx
-4
View File
@@ -19,7 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Indexable
▪ [key: `string`]: `T` \| `undefined`
www/apps/docs/content/references/js-client/internal/interfaces/internal.DuplexOptions.mdx
+17 -17
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "defaultEncoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -146,7 +146,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -155,7 +155,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -187,7 +187,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -196,7 +196,7 @@ ___
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../modules/internal.mdx#error)",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -205,7 +205,7 @@ ___
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -278,7 +278,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -378,7 +378,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Duplex`](../classes/internal.Duplex.mdx)",
"type": "[Duplex](../classes/internal.Duplex.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -387,7 +387,7 @@ ___
},
{
"name": "chunks",
"type": "{ `chunk`: `any` ; `encoding`: [`BufferEncoding`](../types/internal.BufferEncoding.mdx) }[]",
"type": "`&#123; chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -396,7 +396,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.EventEmitter-2.mdx
+14 -14
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "error",
"type": "[`Error`](../../modules/internal.mdx#error)",
"type": "[Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -90,7 +90,7 @@ Alias for `emitter.on(eventName, listener)`.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -379,7 +379,7 @@ Alias for `emitter.removeListener()`.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -451,7 +451,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -521,7 +521,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -538,7 +538,7 @@ ___
### prependListener
Adds the `listener` function to the _beginning_ of the listeners array for the
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
already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple
times.
@@ -579,7 +579,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -596,7 +596,7 @@ ___
### 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
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.
```js
@@ -635,7 +635,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -743,7 +743,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -777,7 +777,7 @@ listener array for the specified `eventName`, then `removeListener()` must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls \_after\_ emitting and \_before\_ the last listener finishes execution
will not remove them from`emit()` in progress. Subsequent events behave as expected.
```js
@@ -813,7 +813,7 @@ myEmitter.emit('event');
```
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered _after_ the listener
change the position indices of any listener registered \_after\_ the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the `emitter.listeners()` method will need to be recreated.
@@ -868,7 +868,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -911,7 +911,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "EventEmitter",
"type": "[`EventEmitter`](internal.EventEmitter-2.mdx)",
"type": "[EventEmitter](internal.EventEmitter-2.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.File.mdx
+4 -4
View File
@@ -71,7 +71,7 @@ Provides information about files and allows JavaScript in a web page to access t
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`ArrayBuffer`\\>",
"type": "Promise&#60;ArrayBuffer&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -123,7 +123,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Blob",
"type": "`Blob`",
"type": "Blob",
"optional": false,
"defaultValue": "",
"description": "",
@@ -143,7 +143,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](../../modules/internal.mdx#readablestream)<`Uint8Array`\\>",
"type": "[ReadableStream](../../modules/internal.mdx#readablestream)&#60;Uint8Array&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -163,7 +163,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.FilePropertyBag.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "endings",
"type": "[`EndingType`](../types/internal.EndingType.mdx)",
"type": "[EndingType](../types/internal.EndingType.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.HTTPResponse.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "headers",
"type": "Record<`string`, `string`\\> & { `set-cookie?`: `string`[] }",
"type": "`Record<string, string>` & `&#123; set-cookie?: string[] &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.HeadersDefaults.mdx
+11 -11
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "common",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "delete",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "get",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "head",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "link",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "patch",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "post",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -83,7 +83,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "purge",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "put",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "unlink",
"type": "[`AxiosRequestHeaders`](../types/internal.AxiosRequestHeaders.mdx)",
"type": "[AxiosRequestHeaders](../types/internal.AxiosRequestHeaders.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx
+3 -3
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<``null`` \\| `T`\\>",
"type": "Promise&#60;`null` \\| T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -61,7 +61,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -111,7 +111,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IEventBusModuleService.mdx
+12 -16
View File
@@ -6,15 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# IEventBusModuleService
## Implemented by
- [`AbstractEventBusModuleService`](../classes/internal.AbstractEventBusModuleService.mdx)
## Methods
### emit
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\>
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;`
#### Parameters
@@ -39,7 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -62,14 +58,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**emit**<`T`\>(`data`): `Promise`<`void`\>
`**emit**<TypeParameter T>(data): Promise&#60;void&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`EmitData`](../types/internal.EmitData.mdx)<`T`\\>[]",
"type": "[EmitData](../types/internal.EmitData.mdx)&#60;T&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -83,7 +79,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -110,7 +106,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/internal.Subscriber.mdx)",
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -119,7 +115,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -133,7 +129,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[`IEventBusModuleService`](internal.IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](internal.IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -160,7 +156,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/internal.Subscriber.mdx)",
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -169,7 +165,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -183,7 +179,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[`IEventBusModuleService`](internal.IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](internal.IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IEventBusService.mdx
+9 -13
View File
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# IEventBusService
## Implemented by
- [`EventBusService`](../classes/internal.internal.EventBusService.mdx)
## Methods
### emit
@@ -51,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`\\>",
"type": "Promise&#60;unknown&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -78,7 +74,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/internal.Subscriber.mdx)",
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +83,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -101,7 +97,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](internal.IEventBusService.mdx)",
"type": "[IEventBusService](internal.IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -128,7 +124,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/internal.Subscriber.mdx)",
"type": "[Subscriber](../types/internal.Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -137,7 +133,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/internal.SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/internal.SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -151,7 +147,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](internal.IEventBusService.mdx)",
"type": "[IEventBusService](internal.IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -169,7 +165,7 @@ ___
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -183,7 +179,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](internal.IEventBusService.mdx)",
"type": "[IEventBusService](internal.IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IInventoryService.mdx
+74 -74
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../types/internal.Omit.mdx)<[`JoinerServiceConfig`](../../internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx), ``\"serviceName\"`` \\| ``\"primaryKeys\"`` \\| ``\"relationships\"`` \\| ``\"extends\"``\\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\\> ; `type`: ``\"date\"`` \\| ``\"time\"`` \\| ``\"datetime\"`` \\| ``\"bigint\"`` \\| ``\"blob\"`` \\| ``\"uint8array\"`` \\| ``\"array\"`` \\| ``\"enumArray\"`` \\| ``\"enum\"`` \\| ``\"json\"`` \\| ``\"integer\"`` \\| ``\"smallint\"`` \\| ``\"tinyint\"`` \\| ``\"mediumint\"`` \\| ``\"float\"`` \\| ``\"double\"`` \\| ``\"boolean\"`` \\| ``\"decimal\"`` \\| ``\"string\"`` \\| ``\"uuid\"`` \\| ``\"text\"`` }\\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../types/internal.Omit.mdx)&#60;[JoinerServiceConfig](../../internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -60,7 +60,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -74,7 +74,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -119,7 +119,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -133,7 +133,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`boolean`\\>",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -151,7 +151,7 @@ ___
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
"type": "[CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -160,7 +160,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -174,7 +174,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -192,7 +192,7 @@ ___
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[]",
"type": "[CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -215,7 +215,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -233,7 +233,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateInventoryLevelInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)",
"type": "[CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -242,7 +242,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -256,7 +256,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -274,7 +274,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateInventoryLevelInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[]",
"type": "[CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -297,7 +297,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -315,7 +315,7 @@ ___
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateReservationItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)",
"type": "[CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -324,7 +324,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -338,7 +338,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -356,7 +356,7 @@ ___
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateReservationItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[]",
"type": "[CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -365,7 +365,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -379,7 +379,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)[]\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -406,7 +406,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -420,7 +420,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -447,7 +447,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -461,7 +461,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -497,7 +497,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -511,7 +511,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -538,7 +538,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -552,7 +552,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -579,7 +579,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -593,7 +593,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -620,7 +620,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -634,7 +634,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -652,7 +652,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableInventoryItemProps`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)",
"type": "[FilterableInventoryItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -661,7 +661,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -670,7 +670,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -684,7 +684,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -702,7 +702,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableInventoryLevelProps`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)",
"type": "[FilterableInventoryLevelProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -711,7 +711,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -720,7 +720,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -734,7 +734,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -752,7 +752,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableReservationItemProps`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)",
"type": "[FilterableReservationItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -770,7 +770,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -784,7 +784,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -811,7 +811,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -825,7 +825,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -861,7 +861,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -875,7 +875,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -902,7 +902,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -911,7 +911,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -925,7 +925,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -961,7 +961,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -975,7 +975,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1002,7 +1002,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1016,7 +1016,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1052,7 +1052,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1066,7 +1066,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1102,7 +1102,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1116,7 +1116,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1143,7 +1143,7 @@ ___
},
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
"type": "[CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1152,7 +1152,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1166,7 +1166,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1202,7 +1202,7 @@ ___
},
{
"name": "update",
"type": "[`UpdateInventoryLevelInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)",
"type": "[UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1211,7 +1211,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1225,7 +1225,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1243,7 +1243,7 @@ ___
<ParameterTypes parameters={[
{
"name": "updates",
"type": "{ `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)[]",
"type": "`&#123; inventory_item_id: string ; location_id: string &#125;` & [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1252,7 +1252,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1266,7 +1266,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1293,7 +1293,7 @@ ___
},
{
"name": "input",
"type": "[`UpdateReservationItemInput`](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)",
"type": "[UpdateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1302,7 +1302,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1316,7 +1316,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/internal.ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IPricingModuleService.mdx
+147 -147
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx
+20 -20
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../types/internal.Omit.mdx)<[`JoinerServiceConfig`](../../internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx), ``\"serviceName\"`` \\| ``\"primaryKeys\"`` \\| ``\"relationships\"`` \\| ``\"extends\"``\\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\\> ; `type`: ``\"date\"`` \\| ``\"time\"`` \\| ``\"datetime\"`` \\| ``\"bigint\"`` \\| ``\"blob\"`` \\| ``\"uint8array\"`` \\| ``\"array\"`` \\| ``\"enumArray\"`` \\| ``\"enum\"`` \\| ``\"json\"`` \\| ``\"integer\"`` \\| ``\"smallint\"`` \\| ``\"tinyint\"`` \\| ``\"mediumint\"`` \\| ``\"float\"`` \\| ``\"double\"`` \\| ``\"boolean\"`` \\| ``\"decimal\"`` \\| ``\"string\"`` \\| ``\"uuid\"`` \\| ``\"text\"`` }\\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../types/internal.Omit.mdx)&#60;[JoinerServiceConfig](../../internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ ___
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateStockLocationInput`](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx)",
"type": "[CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -42,7 +42,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -83,7 +83,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -97,7 +97,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -115,7 +115,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -124,7 +124,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -133,7 +133,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)[]\\>",
"type": "Promise&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -165,7 +165,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -183,7 +183,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -197,7 +197,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -224,7 +224,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -233,7 +233,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -247,7 +247,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -274,7 +274,7 @@ ___
},
{
"name": "input",
"type": "[`UpdateStockLocationInput`](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx)",
"type": "[UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"type": "[SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -297,7 +297,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/internal.StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ITransactionBaseService.mdx
+2 -2
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "ITransactionBaseService",
"type": "[`ITransactionBaseService`](internal.ITransactionBaseService.mdx)",
"type": "[ITransactionBaseService](internal.ITransactionBaseService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IpcSocketConnectOpts.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "onread",
"type": "[`OnReadOpts`](internal.OnReadOpts.mdx)",
"type": "[OnReadOpts](internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterable.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Iterator",
"type": "[`Iterator`](internal.Iterator.mdx)<`T`, `any`, `undefined`\\>",
"type": "[Iterator](internal.Iterator.mdx)&#60;T, any, undefined&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.IterableIterator.mdx
+4 -4
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](internal.IterableIterator.mdx)<`T`\\>",
"type": "[IterableIterator](internal.IterableIterator.mdx)&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -61,7 +61,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -93,7 +93,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -125,7 +125,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.Iterator.mdx
+3 -3
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -93,7 +93,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -125,7 +125,7 @@ ___
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/internal.IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/internal.IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.OnReadOpts.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "buffer",
"type": "`Uint8Array` \\| () => `Uint8Array`",
"type": "Uint8Array \\| () => Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -42,7 +42,7 @@ Return false from this function to implicitly pause() the socket.
},
{
"name": "buf",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.PromiseLike.mdx
+3 -3
View File
@@ -31,7 +31,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "onfulfilled",
"type": "``null`` \\| (`value`: `T`) => `TResult1` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TResult1`\\>",
"type": "``null`` \\| (`value`: `T`) => `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TResult1&#62;",
"description": "The callback to execute when the Promise is resolved.",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
},
{
"name": "onrejected",
"type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`TResult2`\\>",
"type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;TResult2&#62;",
"description": "The callback to execute when the Promise is rejected.",
"optional": true,
"defaultValue": "",
@@ -54,7 +54,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
<ParameterTypes parameters={[
{
"name": "PromiseLike",
"type": "[`PromiseLike`](internal.PromiseLike.mdx)<`TResult1` \\| `TResult2`\\>",
"type": "[PromiseLike](internal.PromiseLike.mdx)&#60;TResult1 \\| TResult2&#62;",
"optional": false,
"defaultValue": "",
"description": "A Promise for the completion of which ever callback is executed.",
www/apps/docs/content/references/js-client/internal/interfaces/internal.QueuingStrategy-1.mdx
+1 -1
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "size",
"type": "[`QueuingStrategySize`](internal.QueuingStrategySize-1.mdx)<`T`\\>",
"type": "[QueuingStrategySize](internal.QueuingStrategySize-1.mdx)&#60;T&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.QueuingStrategy.mdx
+1 -1
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "size",
"type": "[`QueuingStrategySize`](internal.QueuingStrategySize.mdx)<`T`\\>",
"type": "[QueuingStrategySize](internal.QueuingStrategySize.mdx)&#60;T&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.QueuingStrategySize-1.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### QueuingStrategySize
#### Parameters
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`T`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "number",
"type": "`number`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.QueuingStrategySize.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### QueuingStrategySize
#### Parameters
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`T`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "number",
"type": "`number`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx
+40 -40
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "AsyncIterableIterator",
"type": "[`AsyncIterableIterator`](internal.AsyncIterableIterator.mdx)<`string` \\| [`Buffer`](../../modules/internal.mdx#buffer)\\>",
"type": "[AsyncIterableIterator](internal.AsyncIterableIterator.mdx)&#60;string \\| [Buffer](../../modules/internal.mdx#buffer)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -56,7 +56,7 @@ ___
<ParameterTypes parameters={[
{
"name": "error",
"type": "[`Error`](../../modules/internal.mdx#error)",
"type": "[Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -131,7 +131,7 @@ Alias for `emitter.on(eventName, listener)`.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -231,7 +231,7 @@ ___
### end
**end**(`cb?`): [`ReadWriteStream`](internal.ReadWriteStream.mdx)
`**end**(cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
#### Parameters
@@ -252,7 +252,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -261,14 +261,14 @@ ___
}
]} />
**end**(`data`, `cb?`): [`ReadWriteStream`](internal.ReadWriteStream.mdx)
`**end**(data, cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`string` \\| `Uint8Array`",
"type": "`string` \\| Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -300,7 +300,7 @@ ___
}
]} />
**end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](internal.ReadWriteStream.mdx)
`**end**(str, encoding?, cb?): [ReadWriteStream](internal.ReadWriteStream.mdx)`
#### Parameters
@@ -316,7 +316,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -339,7 +339,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -559,7 +559,7 @@ Alias for `emitter.removeListener()`.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -631,7 +631,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -701,7 +701,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -723,7 +723,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -776,7 +776,7 @@ ___
### prependListener
Adds the `listener` function to the _beginning_ of the listeners array for the
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
already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple
times.
@@ -817,7 +817,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -834,7 +834,7 @@ ___
### 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
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.
```js
@@ -873,7 +873,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -973,7 +973,7 @@ ___
<ParameterTypes parameters={[
{
"name": "string \\| Buffer",
"type": "`string` \\| [`Buffer`](../../modules/internal.mdx#buffer)",
"type": "`string` \\| [Buffer](../../modules/internal.mdx#buffer)",
"optional": true,
"defaultValue": "",
"description": "",
@@ -1013,7 +1013,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1047,7 +1047,7 @@ listener array for the specified `eventName`, then `removeListener()` must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls \_after\_ emitting and \_before\_ the last listener finishes execution
will not remove them from`emit()` in progress. Subsequent events behave as expected.
```js
@@ -1083,7 +1083,7 @@ myEmitter.emit('event');
```
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered _after_ the listener
change the position indices of any listener registered \_after\_ the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the `emitter.listeners()` method will need to be recreated.
@@ -1138,7 +1138,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1160,7 +1160,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1178,7 +1178,7 @@ ___
<ParameterTypes parameters={[
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1192,7 +1192,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1231,7 +1231,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1253,7 +1253,7 @@ ___
<ParameterTypes parameters={[
{
"name": "destination",
"type": "[`WritableStream`](internal.WritableStream.mdx)",
"type": "[WritableStream](internal.WritableStream.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1267,7 +1267,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1285,7 +1285,7 @@ ___
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`string` \\| `Uint8Array`",
"type": "`string` \\| Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1294,7 +1294,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1326,7 +1326,7 @@ ___
<ParameterTypes parameters={[
{
"name": "oldStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1340,7 +1340,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadWriteStream",
"type": "[`ReadWriteStream`](internal.ReadWriteStream.mdx)",
"type": "[ReadWriteStream](internal.ReadWriteStream.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1353,14 +1353,14 @@ ___
### write
**write**(`buffer`, `cb?`): `boolean`
`**write**(buffer, cb?): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "buffer",
"type": "`string` \\| `Uint8Array`",
"type": "`string` \\| Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1369,7 +1369,7 @@ ___
},
{
"name": "cb",
"type": "(`err?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1392,7 +1392,7 @@ ___
}
]} />
**write**(`str`, `encoding?`, `cb?`): `boolean`
`**write**(str, encoding?, cb?): boolean`
#### Parameters
@@ -1408,7 +1408,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1417,7 +1417,7 @@ ___
},
{
"name": "cb",
"type": "(`err?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx
+1 -1
View File
@@ -56,7 +56,7 @@ ___
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "[`ArrayBufferView`](internal.ArrayBufferView.mdx)",
"type": "[ArrayBufferView](internal.ArrayBufferView.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "byobRequest",
"type": "``null`` \\| [`ReadableStreamBYOBRequest`](../../modules/internal.mdx#readablestreambyobrequest)",
"type": "``null`` \\| [ReadableStreamBYOBRequest](../../modules/internal.mdx#readablestreambyobrequest)",
"description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest)",
"optional": false,
"defaultValue": "",
@@ -62,7 +62,7 @@ ___
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "[`ArrayBufferView`](internal.ArrayBufferView.mdx)",
"type": "[ArrayBufferView](internal.ArrayBufferView.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamControllerCallback.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# ReadableByteStreamControllerCallback
## Callable
### ReadableByteStreamControllerCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`ReadableByteStreamController`](../../modules/internal.mdx#readablebytestreamcontroller-1)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableOptions.mdx
+8 -8
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../classes/internal.Readable.mdx)",
"type": "[Readable](../classes/internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -83,7 +83,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -115,7 +115,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../classes/internal.Readable.mdx)",
"type": "[Readable](../classes/internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -124,7 +124,7 @@ ___
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../modules/internal.mdx#error)",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -133,7 +133,7 @@ ___
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../classes/internal.Readable.mdx)",
"type": "[Readable](../classes/internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-1.mdx
+26 -30
View File
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ReadableStream
## Implemented by
- [`ReadableBase`](../classes/internal.ReadableBase.mdx)
## Properties
<ParameterTypes parameters={[
@@ -33,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "AsyncIterableIterator",
"type": "[`AsyncIterableIterator`](internal.AsyncIterableIterator.mdx)<`string` \\| [`Buffer`](../../modules/internal.mdx#buffer)\\>",
"type": "[AsyncIterableIterator](internal.AsyncIterableIterator.mdx)&#60;string \\| [Buffer](../../modules/internal.mdx#buffer)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -51,7 +47,7 @@ ___
<ParameterTypes parameters={[
{
"name": "error",
"type": "[`Error`](../../modules/internal.mdx#error)",
"type": "[Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -126,7 +122,7 @@ Alias for `emitter.on(eventName, listener)`.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -433,7 +429,7 @@ Alias for `emitter.removeListener()`.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -505,7 +501,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -575,7 +571,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -597,7 +593,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -650,7 +646,7 @@ ___
### prependListener
Adds the `listener` function to the _beginning_ of the listeners array for the
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
already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple
times.
@@ -691,7 +687,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -708,7 +704,7 @@ ___
### 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
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.
```js
@@ -747,7 +743,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -847,7 +843,7 @@ ___
<ParameterTypes parameters={[
{
"name": "string \\| Buffer",
"type": "`string` \\| [`Buffer`](../../modules/internal.mdx#buffer)",
"type": "`string` \\| [Buffer](../../modules/internal.mdx#buffer)",
"optional": true,
"defaultValue": "",
"description": "",
@@ -887,7 +883,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -921,7 +917,7 @@ listener array for the specified `eventName`, then `removeListener()` must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls \_after\_ emitting and \_before\_ the last listener finishes execution
will not remove them from`emit()` in progress. Subsequent events behave as expected.
```js
@@ -957,7 +953,7 @@ myEmitter.emit('event');
```
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered _after_ the listener
change the position indices of any listener registered \_after\_ the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the `emitter.listeners()` method will need to be recreated.
@@ -1012,7 +1008,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1034,7 +1030,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1052,7 +1048,7 @@ ___
<ParameterTypes parameters={[
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1066,7 +1062,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1105,7 +1101,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1127,7 +1123,7 @@ ___
<ParameterTypes parameters={[
{
"name": "destination",
"type": "[`WritableStream`](internal.WritableStream.mdx)",
"type": "[WritableStream](internal.WritableStream.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1141,7 +1137,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1159,7 +1155,7 @@ ___
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`string` \\| `Uint8Array`",
"type": "`string` \\| Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1168,7 +1164,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1200,7 +1196,7 @@ ___
<ParameterTypes parameters={[
{
"name": "oldStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1214,7 +1210,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](internal.ReadableStream-1.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx
+14 -14
View File
@@ -45,7 +45,7 @@ This Streams API interface represents a readable stream of byte data.
<ParameterTypes parameters={[
{
"name": "AsyncIterableIterator",
"type": "[`AsyncIterableIterator`](internal.AsyncIterableIterator.mdx)<`R`\\>",
"type": "[AsyncIterableIterator](internal.AsyncIterableIterator.mdx)&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -77,7 +77,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -90,14 +90,14 @@ ___
### getReader
**getReader**(): [`ReadableStreamDefaultReader`](../../modules/internal.mdx#readablestreamdefaultreader-1)<`R`\>
`**getReader**(): [ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader-1)&#60;R&#62;`
#### Returns
<ParameterTypes parameters={[
{
"name": "ReadableStreamDefaultReader",
"type": "[`ReadableStreamDefaultReader`](../../modules/internal.mdx#readablestreamdefaultreader-1)<`R`\\>",
"type": "[ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader-1)&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -106,7 +106,7 @@ ___
}
]} />
**getReader**(`options`): [`ReadableStreamBYOBReader`](../../modules/internal.mdx#readablestreambyobreader-1)
`**getReader**(options): [ReadableStreamBYOBReader](../../modules/internal.mdx#readablestreambyobreader-1)`
#### Parameters
@@ -154,7 +154,7 @@ ___
<ParameterTypes parameters={[
{
"name": "transform",
"type": "[`ReadableWritablePair`](internal.ReadableWritablePair-1.mdx)<`T`, `R`\\>",
"type": "[ReadableWritablePair](internal.ReadableWritablePair-1.mdx)&#60;T, R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -163,7 +163,7 @@ ___
},
{
"name": "options",
"type": "[`StreamPipeOptions`](internal.StreamPipeOptions-1.mdx)",
"type": "[StreamPipeOptions](internal.StreamPipeOptions-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -177,7 +177,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`T`\\>",
"type": "[ReadableStream](../../modules/internal.mdx#readablestream-1)&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -195,7 +195,7 @@ ___
<ParameterTypes parameters={[
{
"name": "destination",
"type": "[`WritableStream`](../../modules/internal.mdx#writablestream-1)<`R`\\>",
"type": "[WritableStream](../../modules/internal.mdx#writablestream-1)&#60;R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -204,7 +204,7 @@ ___
},
{
"name": "options",
"type": "[`StreamPipeOptions`](internal.StreamPipeOptions-1.mdx)",
"type": "[StreamPipeOptions](internal.StreamPipeOptions-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -218,7 +218,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -235,8 +235,8 @@ ___
<ParameterTypes parameters={[
{
"name": "[[`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`R`\\>, [`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`R`\\>]",
"type": "[[`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`R`\\>, [`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`R`\\>]",
"name": "[ReadableStream&#60;R&#62;, ReadableStream&#60;R&#62;]",
"type": "[[ReadableStream](../../modules/internal.mdx#readablestream-1)&#60;R&#62;, [ReadableStream](../../modules/internal.mdx#readablestream-1)&#60;R&#62;]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -277,7 +277,7 @@ ___
<ParameterTypes parameters={[
{
"name": "AsyncIterableIterator",
"type": "[`AsyncIterableIterator`](internal.AsyncIterableIterator.mdx)<`R`\\>",
"type": "[AsyncIterableIterator](internal.AsyncIterableIterator.mdx)&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx
+16 -16
View File
@@ -63,7 +63,7 @@ This Streams API interface represents a readable stream of byte data. The Fetch
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -76,7 +76,7 @@ ___
### getReader
**getReader**(`options`): [`ReadableStreamBYOBReader`](../../modules/internal.mdx#readablestreambyobreader)
`**getReader**(options): [ReadableStreamBYOBReader](../../modules/internal.mdx#readablestreambyobreader)`
[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader)
@@ -108,7 +108,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStreamBYOBReader",
"type": "(`stream`: [`ReadableStream`](../../modules/internal.mdx#readablestream)<`any`\\>) => [`ReadableStreamBYOBReader`](../../modules/internal.mdx#readablestreambyobreader)",
"type": "(`stream`: [ReadableStream](../../modules/internal.mdx#readablestream)&#60;any&#62;) => [ReadableStreamBYOBReader](../../modules/internal.mdx#readablestreambyobreader)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -117,14 +117,14 @@ ___
}
]} />
**getReader**(): [`ReadableStreamDefaultReader`](../../modules/internal.mdx#readablestreamdefaultreader)<`R`\>
`**getReader**(): [ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader)&#60;R&#62;`
#### Returns
<ParameterTypes parameters={[
{
"name": "ReadableStreamDefaultReader",
"type": "[`ReadableStreamDefaultReader`](../../modules/internal.mdx#readablestreamdefaultreader)<`R`\\>",
"type": "[ReadableStreamDefaultReader](../../modules/internal.mdx#readablestreamdefaultreader)&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -133,14 +133,14 @@ ___
}
]} />
**getReader**(`options?`): [`ReadableStreamReader`](../types/internal.ReadableStreamReader.mdx)<`R`\>
`**getReader**(options?): [ReadableStreamReader](../types/internal.ReadableStreamReader.mdx)&#60;R&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "options",
"type": "[`ReadableStreamGetReaderOptions`](internal.ReadableStreamGetReaderOptions.mdx)",
"type": "[ReadableStreamGetReaderOptions](internal.ReadableStreamGetReaderOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -154,7 +154,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStreamReader",
"type": "[`ReadableStreamReader`](../types/internal.ReadableStreamReader.mdx)<`R`\\>",
"type": "[ReadableStreamReader](../types/internal.ReadableStreamReader.mdx)&#60;R&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -174,7 +174,7 @@ ___
<ParameterTypes parameters={[
{
"name": "transform",
"type": "[`ReadableWritablePair`](internal.ReadableWritablePair.mdx)<`T`, `R`\\>",
"type": "[ReadableWritablePair](internal.ReadableWritablePair.mdx)&#60;T, R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ ___
},
{
"name": "options",
"type": "[`StreamPipeOptions`](internal.StreamPipeOptions.mdx)",
"type": "[StreamPipeOptions](internal.StreamPipeOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -197,7 +197,7 @@ ___
<ParameterTypes parameters={[
{
"name": "ReadableStream",
"type": "[`ReadableStream`](../../modules/internal.mdx#readablestream)<`T`\\>",
"type": "[ReadableStream](../../modules/internal.mdx#readablestream)&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -217,7 +217,7 @@ ___
<ParameterTypes parameters={[
{
"name": "destination",
"type": "[`WritableStream`](../../modules/internal.mdx#writablestream)<`R`\\>",
"type": "[WritableStream](../../modules/internal.mdx#writablestream)&#60;R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -226,7 +226,7 @@ ___
},
{
"name": "options",
"type": "[`StreamPipeOptions`](internal.StreamPipeOptions.mdx)",
"type": "[StreamPipeOptions](internal.StreamPipeOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -240,7 +240,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -259,8 +259,8 @@ ___
<ParameterTypes parameters={[
{
"name": "[[`ReadableStream`](../../modules/internal.mdx#readablestream)<`R`\\>, [`ReadableStream`](../../modules/internal.mdx#readablestream)<`R`\\>]",
"type": "[[`ReadableStream`](../../modules/internal.mdx#readablestream)<`R`\\>, [`ReadableStream`](../../modules/internal.mdx#readablestream)<`R`\\>]",
"name": "[ReadableStream&#60;R&#62;, ReadableStream&#60;R&#62;]",
"type": "[[ReadableStream](../../modules/internal.mdx#readablestream)&#60;R&#62;, [ReadableStream](../../modules/internal.mdx#readablestream)&#60;R&#62;]",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBReader-1.mdx
+3 -3
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -75,7 +75,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReadableStreamReadResult`](../types/internal.ReadableStreamReadResult-1.mdx)<`T`\\>\\>",
"type": "Promise&#60;[ReadableStreamReadResult](../types/internal.ReadableStreamReadResult-1.mdx)&#60;T&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBReader.mdx
+3 -3
View File
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)",
"optional": false,
"defaultValue": "",
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -81,7 +81,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReadableStreamReadResult`](../types/internal.ReadableStreamReadResult.mdx)<`T`\\>\\>",
"type": "Promise&#60;[ReadableStreamReadResult](../types/internal.ReadableStreamReadResult.mdx)&#60;T&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "view",
"type": "``null`` \\| [`ArrayBufferView`](internal.ArrayBufferView.mdx)",
"type": "``null`` \\| [ArrayBufferView](internal.ArrayBufferView.mdx)",
"description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view)",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ ___
<ParameterTypes parameters={[
{
"name": "view",
"type": "[`ArrayBufferView`](internal.ArrayBufferView.mdx)",
"type": "[ArrayBufferView](internal.ArrayBufferView.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultReader-1.mdx
+3 -3
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -75,7 +75,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReadableStreamDefaultReadResult`](../types/internal.ReadableStreamDefaultReadResult.mdx)<`R`\\>\\>",
"type": "Promise&#60;[ReadableStreamDefaultReadResult](../types/internal.ReadableStreamDefaultReadResult.mdx)&#60;R&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamDefaultReader.mdx
+3 -3
View File
@@ -27,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)",
"optional": false,
"defaultValue": "",
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -81,7 +81,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReadableStreamReadResult`](../types/internal.ReadableStreamReadResult.mdx)<`R`\\>\\>",
"type": "Promise&#60;[ReadableStreamReadResult](../types/internal.ReadableStreamReadResult.mdx)&#60;R&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamErrorCallback.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# ReadableStreamErrorCallback
## Callable
### ReadableStreamErrorCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "reason",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamGenericReader-1.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamGenericReader.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "closed",
"type": "`Promise`<`undefined`\\>",
"type": "Promise&#60;undefined&#62;",
"description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)",
"optional": false,
"defaultValue": "",
@@ -45,7 +45,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableWritablePair-1.mdx
+3 -3
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "readable",
"type": "[`ReadableStream`](../../modules/internal.mdx#readablestream-1)<`R`\\>",
"type": "[ReadableStream](../../modules/internal.mdx#readablestream-1)&#60;R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -43,8 +43,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "writable",
"type": "[`WritableStream`](../../modules/internal.mdx#writablestream-1)<`W`\\>",
"description": "Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.",
"type": "[WritableStream](../../modules/internal.mdx#writablestream-1)&#60;W&#62;",
"description": "Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other &#123; writable, readable &#125; pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableWritablePair.mdx
+3 -3
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "readable",
"type": "[`ReadableStream`](../../modules/internal.mdx#readablestream)<`R`\\>",
"type": "[ReadableStream](../../modules/internal.mdx#readablestream)&#60;R&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -43,8 +43,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "writable",
"type": "[`WritableStream`](../../modules/internal.mdx#writablestream)<`W`\\>",
"description": "Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.",
"type": "[WritableStream](../../modules/internal.mdx#writablestream)&#60;W&#62;",
"description": "Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other &#123; writable, readable &#125; pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/js-client/internal/interfaces/internal.RetryConfig.mdx
+3 -3
View File
@@ -49,7 +49,7 @@ Configuration for the Axios `request` method.
},
{
"name": "instance",
"type": "[`AxiosInstance`](internal.AxiosInstance.mdx)",
"type": "[AxiosInstance](internal.AxiosInstance.mdx)",
"description": "The instance of the axios object to which the interceptor is attached.",
"optional": true,
"defaultValue": "",
@@ -85,7 +85,7 @@ Configuration for the Axios `request` method.
},
{
"name": "onRetryAttempt",
"type": "(`err`: [`AxiosError`](internal.AxiosError.mdx)<`any`, `any`\\>) => `void`",
"type": "(`err`: [AxiosError](internal.AxiosError.mdx)&#60;any, any&#62;) => `void`",
"description": "Function to invoke when a retry attempt is made.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ Configuration for the Axios `request` method.
},
{
"name": "shouldRetry",
"type": "(`err`: [`AxiosError`](internal.AxiosError.mdx)<`any`, `any`\\>) => `boolean`",
"type": "(`err`: [AxiosError](internal.AxiosError.mdx)&#60;any, any&#62;) => `boolean`",
"description": "Function to invoke which determines if you should retry",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.SharedArrayBuffer.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "[species]",
"type": "[`SharedArrayBuffer`](../../modules/internal.mdx#sharedarraybuffer)",
"type": "[SharedArrayBuffer](../../modules/internal.mdx#sharedarraybuffer)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -72,7 +72,7 @@ Returns a section of an SharedArrayBuffer.
<ParameterTypes parameters={[
{
"name": "SharedArrayBuffer",
"type": "[`SharedArrayBufferConstructor`](internal.SharedArrayBufferConstructor.mdx)",
"type": "[SharedArrayBufferConstructor](internal.SharedArrayBufferConstructor.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.SharedArrayBufferConstructor.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "prototype",
"type": "[`SharedArrayBuffer`](../../modules/internal.mdx#sharedarraybuffer)",
"type": "[SharedArrayBuffer](../../modules/internal.mdx#sharedarraybuffer)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.SocketConstructorOpts.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.StaticEventEmitterOptions.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.StreamPipeOptions-1.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.StreamPipeOptions.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.TcpSocketConnectOpts.mdx
+2 -2
View File
@@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lookup",
"type": "[`LookupFunction`](../types/internal.LookupFunction.mdx)",
"type": "[LookupFunction](../types/internal.LookupFunction.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -110,7 +110,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "onread",
"type": "[`OnReadOpts`](internal.OnReadOpts.mdx)",
"type": "[OnReadOpts](internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.TransformOptions.mdx
+22 -22
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "defaultEncoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -146,7 +146,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -155,7 +155,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -187,7 +187,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -196,7 +196,7 @@ ___
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../modules/internal.mdx#error)",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -205,7 +205,7 @@ ___
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -278,7 +278,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -287,7 +287,7 @@ ___
},
{
"name": "callback",
"type": "[`TransformCallback`](../types/internal.TransformCallback.mdx)",
"type": "[TransformCallback](../types/internal.TransformCallback.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -360,7 +360,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -378,7 +378,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -387,7 +387,7 @@ ___
},
{
"name": "callback",
"type": "[`TransformCallback`](../types/internal.TransformCallback.mdx)",
"type": "[TransformCallback](../types/internal.TransformCallback.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -478,7 +478,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Transform`](../classes/internal.Transform.mdx)",
"type": "[Transform](../classes/internal.Transform.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -487,7 +487,7 @@ ___
},
{
"name": "chunks",
"type": "{ `chunk`: `any` ; `encoding`: [`BufferEncoding`](../types/internal.BufferEncoding.mdx) }[]",
"type": "`&#123; chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -496,7 +496,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource-1.mdx
+3 -3
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cancel",
"type": "[`ReadableStreamErrorCallback`](internal.ReadableStreamErrorCallback.mdx)",
"type": "[ReadableStreamErrorCallback](internal.ReadableStreamErrorCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "pull",
"type": "[`ReadableByteStreamControllerCallback`](internal.ReadableByteStreamControllerCallback.mdx)",
"type": "[ReadableByteStreamControllerCallback](internal.ReadableByteStreamControllerCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "[`ReadableByteStreamControllerCallback`](internal.ReadableByteStreamControllerCallback.mdx)",
"type": "[ReadableByteStreamControllerCallback](internal.ReadableByteStreamControllerCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource.mdx
+3 -3
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cancel",
"type": "[`UnderlyingSourceCancelCallback`](internal.UnderlyingSourceCancelCallback.mdx)",
"type": "[UnderlyingSourceCancelCallback](internal.UnderlyingSourceCancelCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "pull",
"type": "(`controller`: [`ReadableByteStreamController`](../../modules/internal.mdx#readablebytestreamcontroller)) => `void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"type": "(`controller`: [ReadableByteStreamController](../../modules/internal.mdx#readablebytestreamcontroller)) => `void` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;void&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "(`controller`: [`ReadableByteStreamController`](../../modules/internal.mdx#readablebytestreamcontroller)) => `any`",
"type": "(`controller`: [ReadableByteStreamController](../../modules/internal.mdx#readablebytestreamcontroller)) => `any`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingDefaultSource.mdx
+3 -3
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "cancel",
"type": "[`UnderlyingSourceCancelCallback`](internal.UnderlyingSourceCancelCallback.mdx)",
"type": "[UnderlyingSourceCancelCallback](internal.UnderlyingSourceCancelCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "pull",
"type": "(`controller`: [`ReadableStreamDefaultController`](../../modules/internal.mdx#readablestreamdefaultcontroller)<`R`\\>) => `void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"type": "(`controller`: [ReadableStreamDefaultController](../../modules/internal.mdx#readablestreamdefaultcontroller)&#60;R&#62;) => `void` \\| [PromiseLike](internal.PromiseLike.mdx)&#60;void&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "(`controller`: [`ReadableStreamDefaultController`](../../modules/internal.mdx#readablestreamdefaultcontroller)<`R`\\>) => `any`",
"type": "(`controller`: [ReadableStreamDefaultController](../../modules/internal.mdx#readablestreamdefaultcontroller)&#60;R&#62;) => `any`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSink-1.mdx
+4 -4
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "abort",
"type": "[`UnderlyingSinkAbortCallback`](internal.UnderlyingSinkAbortCallback-1.mdx)",
"type": "[UnderlyingSinkAbortCallback](internal.UnderlyingSinkAbortCallback-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "close",
"type": "[`UnderlyingSinkCloseCallback`](internal.UnderlyingSinkCloseCallback-1.mdx)",
"type": "[UnderlyingSinkCloseCallback](internal.UnderlyingSinkCloseCallback-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "[`UnderlyingSinkStartCallback`](internal.UnderlyingSinkStartCallback-1.mdx)",
"type": "[UnderlyingSinkStartCallback](internal.UnderlyingSinkStartCallback-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "write",
"type": "[`UnderlyingSinkWriteCallback`](internal.UnderlyingSinkWriteCallback-1.mdx)<`W`\\>",
"type": "[UnderlyingSinkWriteCallback](internal.UnderlyingSinkWriteCallback-1.mdx)&#60;W&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSink.mdx
+4 -4
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "abort",
"type": "[`UnderlyingSinkAbortCallback`](internal.UnderlyingSinkAbortCallback.mdx)",
"type": "[UnderlyingSinkAbortCallback](internal.UnderlyingSinkAbortCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "close",
"type": "[`UnderlyingSinkCloseCallback`](internal.UnderlyingSinkCloseCallback.mdx)",
"type": "[UnderlyingSinkCloseCallback](internal.UnderlyingSinkCloseCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "[`UnderlyingSinkStartCallback`](internal.UnderlyingSinkStartCallback.mdx)",
"type": "[UnderlyingSinkStartCallback](internal.UnderlyingSinkStartCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "write",
"type": "[`UnderlyingSinkWriteCallback`](internal.UnderlyingSinkWriteCallback.mdx)<`W`\\>",
"type": "[UnderlyingSinkWriteCallback](internal.UnderlyingSinkWriteCallback.mdx)&#60;W&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkAbortCallback-1.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkAbortCallback
## Callable
### UnderlyingSinkAbortCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "reason",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkAbortCallback.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkAbortCallback
## Callable
### UnderlyingSinkAbortCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "reason",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkCloseCallback-1.mdx
-18
View File
@@ -5,21 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkCloseCallback
## Callable
### UnderlyingSinkCloseCallback
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkCloseCallback.mdx
-18
View File
@@ -5,21 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkCloseCallback
## Callable
### UnderlyingSinkCloseCallback
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkStartCallback-1.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkStartCallback
## Callable
### UnderlyingSinkStartCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`WritableStreamDefaultController`](../../modules/internal.mdx#writablestreamdefaultcontroller-1)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkStartCallback.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSinkStartCallback
## Callable
### UnderlyingSinkStartCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`WritableStreamDefaultController`](../../modules/internal.mdx#writablestreamdefaultcontroller)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkWriteCallback-1.mdx
-41
View File
@@ -19,44 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSinkWriteCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`W`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "controller",
"type": "[`WritableStreamDefaultController`](../../modules/internal.mdx#writablestreamdefaultcontroller-1)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSinkWriteCallback.mdx
-41
View File
@@ -19,44 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSinkWriteCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "chunk",
"type": "`W`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "controller",
"type": "[`WritableStreamDefaultController`](../../modules/internal.mdx#writablestreamdefaultcontroller)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource-1.mdx
+3 -3
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "cancel",
"type": "[`UnderlyingSourceCancelCallback`](internal.UnderlyingSourceCancelCallback-1.mdx)",
"type": "[UnderlyingSourceCancelCallback](internal.UnderlyingSourceCancelCallback-1.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "pull",
"type": "[`UnderlyingSourcePullCallback`](internal.UnderlyingSourcePullCallback-1.mdx)<`R`\\>",
"type": "[UnderlyingSourcePullCallback](internal.UnderlyingSourcePullCallback-1.mdx)&#60;R&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "[`UnderlyingSourceStartCallback`](internal.UnderlyingSourceStartCallback-1.mdx)<`R`\\>",
"type": "[UnderlyingSourceStartCallback](internal.UnderlyingSourceStartCallback-1.mdx)&#60;R&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource.mdx
+3 -3
View File
@@ -34,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cancel",
"type": "[`UnderlyingSourceCancelCallback`](internal.UnderlyingSourceCancelCallback.mdx)",
"type": "[UnderlyingSourceCancelCallback](internal.UnderlyingSourceCancelCallback.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "pull",
"type": "[`UnderlyingSourcePullCallback`](internal.UnderlyingSourcePullCallback.mdx)<`R`\\>",
"type": "[UnderlyingSourcePullCallback](internal.UnderlyingSourcePullCallback.mdx)&#60;R&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -52,7 +52,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "start",
"type": "[`UnderlyingSourceStartCallback`](internal.UnderlyingSourceStartCallback.mdx)<`R`\\>",
"type": "[UnderlyingSourceStartCallback](internal.UnderlyingSourceStartCallback.mdx)&#60;R&#62;",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourceCancelCallback-1.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSourceCancelCallback
## Callable
### UnderlyingSourceCancelCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "reason",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourceCancelCallback.mdx
-32
View File
@@ -5,35 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# UnderlyingSourceCancelCallback
## Callable
### UnderlyingSourceCancelCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "reason",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourcePullCallback-1.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSourcePullCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`ReadableStreamController`](../types/internal.ReadableStreamController-1.mdx)<`R`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourcePullCallback.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSourcePullCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`ReadableStreamController`](../types/internal.ReadableStreamController.mdx)<`R`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void \\| PromiseLike<void\\>",
"type": "`void` \\| [`PromiseLike`](internal.PromiseLike.mdx)<`void`\\>",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourceStartCallback-1.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSourceStartCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`ReadableStreamController`](../types/internal.ReadableStreamController-1.mdx)<`R`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSourceStartCallback.mdx
-32
View File
@@ -19,35 +19,3 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": []
}
]} />
## Callable
### UnderlyingSourceStartCallback
#### Parameters
<ParameterTypes parameters={[
{
"name": "controller",
"type": "[`ReadableStreamController`](../types/internal.ReadableStreamController.mdx)<`R`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />

Some files were not shown because too many files have changed in this diff Show More