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

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal-3/classes/internal.internal-3.Writable.mdx
+53 -53
View File
@@ -33,7 +33,7 @@ v0.9.4
},
{
"name": "errored",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"type": "`null` \\| [Error](../../modules/internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"optional": false,
"defaultValue": "",
@@ -209,7 +209,7 @@ ___
<ParameterTypes parameters={[
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -241,7 +241,7 @@ ___
<ParameterTypes parameters={[
{
"name": "error",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"type": "`null` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -250,7 +250,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": "",
@@ -282,7 +282,7 @@ ___
<ParameterTypes parameters={[
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -332,7 +332,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": "",
@@ -364,7 +364,7 @@ ___
<ParameterTypes parameters={[
{
"name": "chunks",
"type": "`&#123; chunk: any ; encoding: [BufferEncoding](../../internal/types/internal.BufferEncoding.mdx) &#125;`[]",
"type": "``{ chunk: any ; encoding: [BufferEncoding](../../internal/types/internal.BufferEncoding.mdx) }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,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": "",
@@ -416,7 +416,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -494,7 +494,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -533,7 +533,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -611,7 +611,7 @@ The defined events on documents including:
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -854,7 +854,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -888,7 +888,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -918,7 +918,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -957,7 +957,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1026,7 +1026,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1482,7 +1482,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "The name of the event.",
"optional": false,
"defaultValue": "",
@@ -1525,7 +1525,7 @@ v0.1.101
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1564,7 +1564,7 @@ v0.1.101
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1603,7 +1603,7 @@ v0.1.101
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1642,7 +1642,7 @@ v0.1.101
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1681,7 +1681,7 @@ v0.1.101
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1788,7 +1788,7 @@ myEE.emit('foo');
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "The name of the event.",
"optional": false,
"defaultValue": "",
@@ -1831,7 +1831,7 @@ v0.3.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1870,7 +1870,7 @@ v0.3.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1909,7 +1909,7 @@ v0.3.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1948,7 +1948,7 @@ v0.3.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1987,7 +1987,7 @@ v0.3.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2122,7 +2122,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "The name of the event.",
"optional": false,
"defaultValue": "",
@@ -2165,7 +2165,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2204,7 +2204,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2243,7 +2243,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2282,7 +2282,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2321,7 +2321,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2414,7 +2414,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "The name of the event.",
"optional": false,
"defaultValue": "",
@@ -2457,7 +2457,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2496,7 +2496,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2535,7 +2535,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2574,7 +2574,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2613,7 +2613,7 @@ v6.0.0
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2883,7 +2883,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"close\"``",
"type": "`\"close\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2926,7 +2926,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"drain\"``",
"type": "`\"drain\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2965,7 +2965,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"error\"``",
"type": "`\"error\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -3004,7 +3004,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"finish\"``",
"type": "`\"finish\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -3043,7 +3043,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"pipe\"``",
"type": "`\"pipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -3082,7 +3082,7 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "event",
"type": "``\"unpipe\"``",
"type": "`\"unpipe\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -3356,7 +3356,7 @@ A `Writable` stream in object mode will always ignore the `encoding` argument.
},
{
"name": "callback",
"type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "Callback for when this chunk of data is flushed.",
"optional": true,
"defaultValue": "",
@@ -3408,7 +3408,7 @@ v0.9.4
},
{
"name": "callback",
"type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -3526,7 +3526,7 @@ A utility method for creating a `Writable` from a web `WritableStream`.
},
{
"name": "options",
"type": "[Pick](../../internal/types/internal.Pick.mdx)&#60;[WritableOptions](../interfaces/internal.internal-3.WritableOptions.mdx), `\"signal\"` \\| `\"decodeStrings\"` \\| `\"highWaterMark\"` \\| `\"objectMode\"`&#62;",
"type": "[Pick](../../internal/types/internal.Pick.mdx)&#60;[WritableOptions](../interfaces/internal.internal-3.WritableOptions.mdx), \"signal\" \\| \"decodeStrings\" \\| \"highWaterMark\" \\| \"objectMode\"&#62;",
"description": "",
"optional": true,
"defaultValue": "",