diff options
Diffstat (limited to 'test/scripts')
| -rw-r--r-- | test/scripts/apidoc/__snapshots__/module.spec.ts.snap | 2 | ||||
| -rw-r--r-- | test/scripts/apidoc/__snapshots__/signature.spec.ts.snap | 116 | ||||
| -rw-r--r-- | test/scripts/apidoc/module.spec.ts | 7 | ||||
| -rw-r--r-- | test/scripts/apidoc/signature.debug.ts | 3 | ||||
| -rw-r--r-- | test/scripts/apidoc/signature.spec.ts | 7 | ||||
| -rw-r--r-- | test/scripts/apidoc/utils.ts | 24 | ||||
| -rw-r--r-- | test/scripts/apidoc/verify-jsdoc-tags.spec.ts | 182 |
7 files changed, 181 insertions, 160 deletions
diff --git a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap index 3afdab63..dcd88cd0 100644 --- a/test/scripts/apidoc/__snapshots__/module.spec.ts.snap +++ b/test/scripts/apidoc/__snapshots__/module.spec.ts.snap @@ -12,7 +12,7 @@ exports[`module > analyzeModule() > ModuleExampleTest 1`] = ` { "comment": "This is a description for a module with a code example.", "deprecated": undefined, - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#89DDFF\\">new</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#82AAFF\\">ModuleExampleTest</span><span style=\\"color:#BABED8\\">()</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#F97583\\">new</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#B392F0\\">ModuleExampleTest</span><span style=\\"color:#E1E4E8\\">()</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#D73A49\\">new</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#6F42C1\\">ModuleExampleTest</span><span style=\\"color:#24292E\\">()</span></span></code></pre> </div>", } `; diff --git a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap index 84365003..04e2ee97 100644 --- a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap +++ b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap @@ -5,10 +5,13 @@ exports[`signature > analyzeSignature() > complexArrayParameter 1`] = ` "deprecated": undefined, "description": "<p>Complex array parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">complexArrayParameter</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#FFCB6B\\">T</span><span style=\\"color:#89DDFF\\">></span><span style=\\"color:#BABED8\\">(array: readonly </span><span style=\\"color:#82AAFF\\">Array</span><span style=\\"color:#89DDFF\\"><{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#FFCB6B\\">T</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">weight</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#FFCB6B\\">number</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}></span><span style=\\"color:#BABED8\\">): T</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">complexArrayParameter</span><span style=\\"color:#E1E4E8\\"><</span><span style=\\"color:#B392F0\\">T</span><span style=\\"color:#E1E4E8\\">>(array: readonly </span><span style=\\"color:#B392F0\\">Array</span><span style=\\"color:#E1E4E8\\"><{</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#FFAB70\\">value</span><span style=\\"color:#F97583\\">:</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#B392F0\\">T</span><span style=\\"color:#E1E4E8\\">,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#FFAB70\\">weight</span><span style=\\"color:#F97583\\">:</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#79B8FF\\">number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">}>): </span><span style=\\"color:#79B8FF\\">T</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">complexArrayParameter</span><span style=\\"color:#24292E\\"><</span><span style=\\"color:#6F42C1\\">T</span><span style=\\"color:#24292E\\">>(array: readonly </span><span style=\\"color:#6F42C1\\">Array</span><span style=\\"color:#24292E\\"><{</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> </span><span style=\\"color:#E36209\\">value</span><span style=\\"color:#D73A49\\">:</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#6F42C1\\">T</span><span style=\\"color:#24292E\\">,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> </span><span style=\\"color:#E36209\\">weight</span><span style=\\"color:#D73A49\\">:</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#005CC5\\">number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">}>): </span><span style=\\"color:#005CC5\\">T</span></span></code></pre> </div>", "name": "complexArrayParameter", "parameters": [ @@ -53,7 +56,7 @@ exports[`signature > analyzeSignature() > defaultBooleanParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with a default parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">defaultBooleanParamMethod</span><span style=\\"color:#BABED8\\">(c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">defaultBooleanParamMethod</span><span style=\\"color:#E1E4E8\\">(c: boolean </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#79B8FF\\">true</span><span style=\\"color:#E1E4E8\\">): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">defaultBooleanParamMethod</span><span style=\\"color:#24292E\\">(c: boolean </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#005CC5\\">true</span><span style=\\"color:#24292E\\">): number</span></span></code></pre> </div>", "name": "defaultBooleanParamMethod", "parameters": [ @@ -105,7 +108,7 @@ exports[`signature > analyzeSignature() > functionParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with a function parameters.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">functionParamMethod</span><span style=\\"color:#BABED8\\">(fn: </span><span style=\\"color:#89DDFF\\">(</span><span style=\\"color:#BABED8;font-style:italic\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#FFCB6B\\">string</span><span style=\\"color:#89DDFF\\">)</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#C792EA\\">=></span><span style=\\"color:#BABED8\\"> number): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">functionParamMethod</span><span style=\\"color:#E1E4E8\\">(fn: (</span><span style=\\"color:#FFAB70\\">a</span><span style=\\"color:#F97583\\">:</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#79B8FF\\">string</span><span style=\\"color:#E1E4E8\\">) </span><span style=\\"color:#F97583\\">=></span><span style=\\"color:#E1E4E8\\"> number): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">functionParamMethod</span><span style=\\"color:#24292E\\">(fn: (</span><span style=\\"color:#E36209\\">a</span><span style=\\"color:#D73A49\\">:</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#005CC5\\">string</span><span style=\\"color:#24292E\\">) </span><span style=\\"color:#D73A49\\">=></span><span style=\\"color:#24292E\\"> number): number</span></span></code></pre> </div>", "name": "functionParamMethod", "parameters": [ @@ -130,7 +133,7 @@ exports[`signature > analyzeSignature() > literalUnionParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with LiteralUnion.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">literalUnionParamMethod</span><span style=\\"color:#BABED8\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> namedValue: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> array: readonly Array</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">>,</span><span style=\\"color:#BABED8\\"> namedArray: readonly Array</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">>,</span><span style=\\"color:#BABED8\\"> mixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> readonly Array</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">>,</span><span style=\\"color:#BABED8\\"> namedMixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> readonly Array</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">></span><span style=\\"color:#BABED8\\">): string</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">literalUnionParamMethod</span><span style=\\"color:#E1E4E8\\">(value: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string, namedValue: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string, array: readonly Array</span><span style=\\"color:#F97583\\"><</span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string</span><span style=\\"color:#F97583\\">></span><span style=\\"color:#E1E4E8\\">, namedArray: readonly Array</span><span style=\\"color:#F97583\\"><</span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string</span><span style=\\"color:#F97583\\">></span><span style=\\"color:#E1E4E8\\">, mixed: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> readonly Array</span><span style=\\"color:#F97583\\"><</span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string</span><span style=\\"color:#F97583\\">></span><span style=\\"color:#E1E4E8\\">, namedMixed: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> readonly Array</span><span style=\\"color:#F97583\\"><</span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string</span><span style=\\"color:#F97583\\">></span><span style=\\"color:#E1E4E8\\">): string</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">literalUnionParamMethod</span><span style=\\"color:#24292E\\">(value: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string, namedValue: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string, array: readonly Array</span><span style=\\"color:#D73A49\\"><</span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string</span><span style=\\"color:#D73A49\\">></span><span style=\\"color:#24292E\\">, namedArray: readonly Array</span><span style=\\"color:#D73A49\\"><</span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string</span><span style=\\"color:#D73A49\\">></span><span style=\\"color:#24292E\\">, mixed: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> readonly Array</span><span style=\\"color:#D73A49\\"><</span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string</span><span style=\\"color:#D73A49\\">></span><span style=\\"color:#24292E\\">, namedMixed: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> readonly Array</span><span style=\\"color:#D73A49\\"><</span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string</span><span style=\\"color:#D73A49\\">></span><span style=\\"color:#24292E\\">): string</span></span></code></pre> </div>", "name": "literalUnionParamMethod", "parameters": [ @@ -191,7 +194,7 @@ exports[`signature > analyzeSignature() > methodWithDeprecated 1`] = ` ", "description": "<p>Test with deprecated and see marker.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithDeprecated</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithDeprecated</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithDeprecated</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithDeprecated", "parameters": [], @@ -210,11 +213,15 @@ exports[`signature > analyzeSignature() > methodWithDeprecatedOption 1`] = ` "deprecated": undefined, "description": "<p>Test with deprecated option.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithDeprecatedOption</span><span style=\\"color:#BABED8\\">(option: </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#82AAFF\\">b</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">()</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#C792EA\\">=></span><span style=\\"color:#BABED8\\"> number</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">c</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> number</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithDeprecatedOption</span><span style=\\"color:#E1E4E8\\">(option: {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> a: string,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#B392F0\\">b</span><span style=\\"color:#E1E4E8\\">: () </span><span style=\\"color:#F97583\\">=></span><span style=\\"color:#E1E4E8\\"> number,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> c: number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">}): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithDeprecatedOption</span><span style=\\"color:#24292E\\">(option: {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> a: string,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> </span><span style=\\"color:#6F42C1\\">b</span><span style=\\"color:#24292E\\">: () </span><span style=\\"color:#D73A49\\">=></span><span style=\\"color:#24292E\\"> number,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> c: number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">}): number</span></span></code></pre> </div>", "name": "methodWithDeprecatedOption", "parameters": [ @@ -262,8 +269,9 @@ exports[`signature > analyzeSignature() > methodWithExample 1`] = ` "deprecated": undefined, "description": "<p>Test with example marker.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithExample</span><span style=\\"color:#BABED8\\">(): number</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\">test</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#BABED8\\">apidoc</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithExample</span><span style=\\"color:#BABED8\\">() </span><span style=\\"color:#676E95;font-style:italic\\">// 0</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithExample</span><span style=\\"color:#E1E4E8\\">(): number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">test.apidoc.</span><span style=\\"color:#B392F0\\">methodWithExample</span><span style=\\"color:#E1E4E8\\">() </span><span style=\\"color:#6A737D\\">// 0</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithExample</span><span style=\\"color:#24292E\\">(): number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">test.apidoc.</span><span style=\\"color:#6F42C1\\">methodWithExample</span><span style=\\"color:#24292E\\">() </span><span style=\\"color:#6A737D\\">// 0</span></span></code></pre> </div>", "name": "methodWithExample", "parameters": [], @@ -280,7 +288,7 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkers 1`] = ` "deprecated": undefined, "description": "<p>Test with multiple see markers.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithMultipleSeeMarkers</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithMultipleSeeMarkers</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithMultipleSeeMarkers</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithMultipleSeeMarkers", "parameters": [], @@ -300,7 +308,7 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkersAndBacktic "deprecated": undefined, "description": "<p>Test with multiple see markers and backticks.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithMultipleSeeMarkersAndBackticks</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithMultipleSeeMarkersAndBackticks</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithMultipleSeeMarkersAndBackticks</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithMultipleSeeMarkersAndBackticks", "parameters": [], @@ -320,7 +328,7 @@ exports[`signature > analyzeSignature() > methodWithMultipleThrows 1`] = ` "deprecated": undefined, "description": "<p>Test with multiple throws.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithMultipleThrows</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithMultipleThrows</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithMultipleThrows</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithMultipleThrows", "parameters": [], @@ -338,7 +346,7 @@ exports[`signature > analyzeSignature() > methodWithSinceMarker 1`] = ` "deprecated": undefined, "description": "<p>Test with since marker.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithSinceMarker</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithSinceMarker</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithSinceMarker</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithSinceMarker", "parameters": [], @@ -355,7 +363,7 @@ exports[`signature > analyzeSignature() > methodWithThrows 1`] = ` "deprecated": undefined, "description": "<p>Test with throws.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">methodWithThrows</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">methodWithThrows</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">methodWithThrows</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "methodWithThrows", "parameters": [], @@ -372,7 +380,7 @@ exports[`signature > analyzeSignature() > multiParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with multiple parameters.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">multiParamMethod</span><span style=\\"color:#BABED8\\">(a: number</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">multiParamMethod</span><span style=\\"color:#E1E4E8\\">(a: number, b</span><span style=\\"color:#F97583\\">?:</span><span style=\\"color:#E1E4E8\\"> string, c: boolean </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#79B8FF\\">true</span><span style=\\"color:#E1E4E8\\">): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">multiParamMethod</span><span style=\\"color:#24292E\\">(a: number, b</span><span style=\\"color:#D73A49\\">?:</span><span style=\\"color:#24292E\\"> string, c: boolean </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#005CC5\\">true</span><span style=\\"color:#24292E\\">): number</span></span></code></pre> </div>", "name": "multiParamMethod", "parameters": [ @@ -411,7 +419,7 @@ exports[`signature > analyzeSignature() > noParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with no parameters.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">noParamMethod</span><span style=\\"color:#BABED8\\">(): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">noParamMethod</span><span style=\\"color:#E1E4E8\\">(): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">noParamMethod</span><span style=\\"color:#24292E\\">(): number</span></span></code></pre> </div>", "name": "noParamMethod", "parameters": [], @@ -428,7 +436,7 @@ exports[`signature > analyzeSignature() > optionalStringParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with an optional parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">optionalStringParamMethod</span><span style=\\"color:#BABED8\\">(b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#BABED8\\"> string): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">optionalStringParamMethod</span><span style=\\"color:#E1E4E8\\">(b</span><span style=\\"color:#F97583\\">?:</span><span style=\\"color:#E1E4E8\\"> string): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">optionalStringParamMethod</span><span style=\\"color:#24292E\\">(b</span><span style=\\"color:#D73A49\\">?:</span><span style=\\"color:#24292E\\"> string): number</span></span></code></pre> </div>", "name": "optionalStringParamMethod", "parameters": [ @@ -453,13 +461,19 @@ exports[`signature > analyzeSignature() > optionsInlineParamMethodWithDefaults 1 "deprecated": undefined, "description": "<p>Test with a function parameters (inline types) with defaults.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">optionsInlineParamMethodWithDefaults</span><span style=\\"color:#BABED8\\">(a: </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> number</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> b: </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> number</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> c: </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> number</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">optionsInlineParamMethodWithDefaults</span><span style=\\"color:#E1E4E8\\">(a: {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">} </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, b: {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">} </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, c: {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">}): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">optionsInlineParamMethodWithDefaults</span><span style=\\"color:#24292E\\">(a: {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">} </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, b: {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">} </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, c: {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> value: number</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">}): number</span></span></code></pre> </div>", "name": "optionsInlineParamMethodWithDefaults", "parameters": [ @@ -521,7 +535,7 @@ exports[`signature > analyzeSignature() > optionsInterfaceParamMethodWithDefault "deprecated": undefined, "description": "<p>Test with a function parameters with defaults.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">optionsInterfaceParamMethodWithDefaults</span><span style=\\"color:#BABED8\\">(a: ParameterOptionsInterfaceA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> b: ParameterOptionsInterfaceB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> c: ParameterOptionsInterfaceC): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">optionsInterfaceParamMethodWithDefaults</span><span style=\\"color:#E1E4E8\\">(a: ParameterOptionsInterfaceA </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, b: ParameterOptionsInterfaceB </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, c: ParameterOptionsInterfaceC): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">optionsInterfaceParamMethodWithDefaults</span><span style=\\"color:#24292E\\">(a: ParameterOptionsInterfaceA </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, b: ParameterOptionsInterfaceB </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, c: ParameterOptionsInterfaceC): number</span></span></code></pre> </div>", "name": "optionsInterfaceParamMethodWithDefaults", "parameters": [ @@ -560,13 +574,19 @@ exports[`signature > analyzeSignature() > optionsParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with an options parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">optionsParamMethod</span><span style=\\"color:#BABED8\\">(options: </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> number</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">b</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">c</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> boolean</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#82AAFF\\">d</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">()</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#C792EA\\">=></span><span style=\\"color:#BABED8\\"> string</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">e</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> string</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">optionsParamMethod</span><span style=\\"color:#E1E4E8\\">(options: {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> a: number,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> b: string,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> c: boolean,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#B392F0\\">d</span><span style=\\"color:#E1E4E8\\">: () </span><span style=\\"color:#F97583\\">=></span><span style=\\"color:#E1E4E8\\"> string,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> e: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> string</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">}): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">optionsParamMethod</span><span style=\\"color:#24292E\\">(options: {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> a: number,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> b: string,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> c: boolean,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> </span><span style=\\"color:#6F42C1\\">d</span><span style=\\"color:#24292E\\">: () </span><span style=\\"color:#D73A49\\">=></span><span style=\\"color:#24292E\\"> string,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> e: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> string</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">}): number</span></span></code></pre> </div>", "name": "optionsParamMethod", "parameters": [ @@ -626,7 +646,7 @@ exports[`signature > analyzeSignature() > optionsTypeParamMethodWithDefaults 1`] "deprecated": undefined, "description": "<p>Test with a function parameters with defaults.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">optionsTypeParamMethodWithDefaults</span><span style=\\"color:#BABED8\\">(a: ParameterOptionsTypeA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> b: ParameterOptionsTypeB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#BABED8\\"> c: ParameterOptionsTypeC): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">optionsTypeParamMethodWithDefaults</span><span style=\\"color:#E1E4E8\\">(a: ParameterOptionsTypeA </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, b: ParameterOptionsTypeB </span><span style=\\"color:#F97583\\">=</span><span style=\\"color:#E1E4E8\\"> { value: </span><span style=\\"color:#79B8FF\\">1</span><span style=\\"color:#E1E4E8\\"> }, c: ParameterOptionsTypeC): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">optionsTypeParamMethodWithDefaults</span><span style=\\"color:#24292E\\">(a: ParameterOptionsTypeA </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, b: ParameterOptionsTypeB </span><span style=\\"color:#D73A49\\">=</span><span style=\\"color:#24292E\\"> { value: </span><span style=\\"color:#005CC5\\">1</span><span style=\\"color:#24292E\\"> }, c: ParameterOptionsTypeC): number</span></span></code></pre> </div>", "name": "optionsTypeParamMethodWithDefaults", "parameters": [ @@ -665,7 +685,7 @@ exports[`signature > analyzeSignature() > recordParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with a Record parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">recordParamMethod</span><span style=\\"color:#BABED8\\">(object: Record</span><span style=\\"color:#89DDFF\\"><</span><span style=\\"color:#BABED8\\">string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> number</span><span style=\\"color:#89DDFF\\">></span><span style=\\"color:#BABED8\\">): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">recordParamMethod</span><span style=\\"color:#E1E4E8\\">(object: Record</span><span style=\\"color:#F97583\\"><</span><span style=\\"color:#E1E4E8\\">string, number</span><span style=\\"color:#F97583\\">></span><span style=\\"color:#E1E4E8\\">): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">recordParamMethod</span><span style=\\"color:#24292E\\">(object: Record</span><span style=\\"color:#D73A49\\"><</span><span style=\\"color:#24292E\\">string, number</span><span style=\\"color:#D73A49\\">></span><span style=\\"color:#24292E\\">): number</span></span></code></pre> </div>", "name": "recordParamMethod", "parameters": [ @@ -690,7 +710,7 @@ exports[`signature > analyzeSignature() > requiredNumberParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with a required parameter.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">requiredNumberParamMethod</span><span style=\\"color:#BABED8\\">(a: number): number</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">requiredNumberParamMethod</span><span style=\\"color:#E1E4E8\\">(a: number): number</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">requiredNumberParamMethod</span><span style=\\"color:#24292E\\">(a: number): number</span></span></code></pre> </div>", "name": "requiredNumberParamMethod", "parameters": [ @@ -715,11 +735,15 @@ exports[`signature > analyzeSignature() > stringUnionParamMethod 1`] = ` "deprecated": undefined, "description": "<p>Test with string union.</p> ", - "examples": "<div class=\\"language-ts\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki material-theme-palenight\\"><code><span class=\\"line\\"><span style=\\"color:#82AAFF\\">stringUnionParamMethod</span><span style=\\"color:#BABED8\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#BABED8\\"> options</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">{</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">casing</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">lower</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">mixed</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">upper</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">excludes</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> readonly AlphaNumericChar[]</span><span style=\\"color:#89DDFF\\">,</span></span> -<span class=\\"line\\"><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#F07178\\">format</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">binary</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">css</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">decimal</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#BABED8\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">hex</span><span style=\\"color:#89DDFF\\">'</span></span> -<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#BABED8\\">): string</span></span></code></pre> + "examples": "<div class=\\"language-ts vp-adaptive-theme\\"><button title=\\"Copy Code\\" class=\\"copy\\"></button><span class=\\"lang\\">ts</span><pre v-pre class=\\"shiki github-dark vp-code-dark\\"><code><span class=\\"line\\"><span style=\\"color:#B392F0\\">stringUnionParamMethod</span><span style=\\"color:#E1E4E8\\">(value: </span><span style=\\"color:#9ECBFF\\">'a'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'b'</span><span style=\\"color:#E1E4E8\\">, options</span><span style=\\"color:#F97583\\">?:</span><span style=\\"color:#E1E4E8\\"> {</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> casing: </span><span style=\\"color:#9ECBFF\\">'lower'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'mixed'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'upper'</span><span style=\\"color:#E1E4E8\\">,</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> excludes: readonly AlphaNumericChar[],</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\"> format: </span><span style=\\"color:#9ECBFF\\">'binary'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'css'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'decimal'</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#F97583\\">|</span><span style=\\"color:#E1E4E8\\"> </span><span style=\\"color:#9ECBFF\\">'hex'</span></span> +<span class=\\"line\\"><span style=\\"color:#E1E4E8\\">}): string</span></span></code></pre><pre v-pre class=\\"shiki github-light vp-code-light\\"><code><span class=\\"line\\"><span style=\\"color:#6F42C1\\">stringUnionParamMethod</span><span style=\\"color:#24292E\\">(value: </span><span style=\\"color:#032F62\\">'a'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'b'</span><span style=\\"color:#24292E\\">, options</span><span style=\\"color:#D73A49\\">?:</span><span style=\\"color:#24292E\\"> {</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> casing: </span><span style=\\"color:#032F62\\">'lower'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'mixed'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'upper'</span><span style=\\"color:#24292E\\">,</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> excludes: readonly AlphaNumericChar[],</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\"> format: </span><span style=\\"color:#032F62\\">'binary'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'css'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'decimal'</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#D73A49\\">|</span><span style=\\"color:#24292E\\"> </span><span style=\\"color:#032F62\\">'hex'</span></span> +<span class=\\"line\\"><span style=\\"color:#24292E\\">}): string</span></span></code></pre> </div>", "name": "stringUnionParamMethod", "parameters": [ diff --git a/test/scripts/apidoc/module.spec.ts b/test/scripts/apidoc/module.spec.ts index 508c9de3..5e55afea 100644 --- a/test/scripts/apidoc/module.spec.ts +++ b/test/scripts/apidoc/module.spec.ts @@ -4,12 +4,11 @@ import { analyzeModule } from '../../../scripts/apidoc/module-methods'; import * as ModuleTests from './module.example'; import { loadExampleModules } from './utils'; +beforeAll(initMarkdownRenderer); +const modules = await loadExampleModules(); + describe('module', () => { describe('analyzeModule()', () => { - const modules = loadExampleModules(); - - beforeAll(initMarkdownRenderer); - it('dummy dependency to rerun the test if the example changes', () => { expect(Object.keys(ModuleTests)).not.toEqual([]); }); diff --git a/test/scripts/apidoc/signature.debug.ts b/test/scripts/apidoc/signature.debug.ts index d72709b0..9e99e8c6 100644 --- a/test/scripts/apidoc/signature.debug.ts +++ b/test/scripts/apidoc/signature.debug.ts @@ -8,10 +8,9 @@ import { loadExampleMethods } from './utils'; /* Run with `pnpm tsx test/scripts/apidoc/signature.debug.ts` */ -const methods = loadExampleMethods(); - initMarkdownRenderer() .then(async () => { + const methods = await loadExampleMethods(); for (const [name, method] of Object.entries(methods)) { console.log('Analyzing:', name); const result = await analyzeSignature(method, '', method.name); diff --git a/test/scripts/apidoc/signature.spec.ts b/test/scripts/apidoc/signature.spec.ts index 75abf23b..51935fcf 100644 --- a/test/scripts/apidoc/signature.spec.ts +++ b/test/scripts/apidoc/signature.spec.ts @@ -4,12 +4,11 @@ import { analyzeSignature } from '../../../scripts/apidoc/signature'; import { SignatureTest } from './signature.example'; import { loadExampleMethods } from './utils'; +beforeAll(initMarkdownRenderer); +const methods = await loadExampleMethods(); + describe('signature', () => { describe('analyzeSignature()', () => { - const methods = loadExampleMethods(); - - beforeAll(initMarkdownRenderer); - it('dummy dependency to rerun the test if the example changes', () => { expect(new SignatureTest()).toBeTruthy(); }); diff --git a/test/scripts/apidoc/utils.ts b/test/scripts/apidoc/utils.ts index ade31120..2752f25b 100644 --- a/test/scripts/apidoc/utils.ts +++ b/test/scripts/apidoc/utils.ts @@ -16,14 +16,13 @@ import { mapByName } from '../../../scripts/apidoc/utils'; * @param options The TypeDoc options. * @param includeTestModules Whether to include the test modules. */ -export function loadProjectModules( +export async function loadProjectModules( options?: Partial<TypeDocOptions>, includeTestModules = false -): Record< - string, - [DeclarationReflection, Record<string, SignatureReflection>] +): Promise< + Record<string, [DeclarationReflection, Record<string, SignatureReflection>]> > { - const [, project] = loadProject(options); + const [, project] = await loadProject(options); const modules = selectApiModules(project, includeTestModules); @@ -33,20 +32,25 @@ export function loadProjectModules( /** * Loads the example methods using TypeDoc. */ -export function loadExampleMethods(): Record<string, SignatureReflection> { - return loadProjectModules( +export async function loadExampleMethods(): Promise< + Record<string, SignatureReflection> +> { + const modules = await loadProjectModules( { entryPoints: ['test/scripts/apidoc/signature.example.ts'], }, true - )['SignatureTest'][1]; + ); + return modules['SignatureTest'][1]; } /** * Loads the example modules using TypeDoc. */ -export function loadExampleModules(): Record<string, DeclarationReflection> { - const modules = loadProjectModules( +export async function loadExampleModules(): Promise< + Record<string, DeclarationReflection> +> { + const modules = await loadProjectModules( { entryPoints: ['test/scripts/apidoc/module.example.ts'], }, diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts index 89afc225..b14523e1 100644 --- a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts +++ b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts @@ -35,115 +35,111 @@ afterAll(() => { } }); -describe('verify JSDoc tags', () => { - const modules = loadProjectModules(); +const modules = await loadProjectModules(); + +function resolveDirToModule(moduleName: string): string { + return resolve(tempDir, moduleName); +} + +function resolvePathToMethodFile( + moduleName: string, + methodName: string +): string { + const dir = resolveDirToModule(moduleName); + return resolve(dir, `${methodName}.ts`); +} + +const allowedReferences = new Set( + Object.values(modules).flatMap(([module, methods]) => { + const moduleFieldName = extractModuleFieldName(module); + return Object.keys(methods).map( + (methodName) => `faker.${moduleFieldName}.${methodName}` + ); + }) +); +const allowedLinks = new Set( + Object.values(modules).flatMap(([module, methods]) => { + const moduleFieldName = extractModuleFieldName(module); + return [ + `/api/${moduleFieldName}.html`, + ...Object.keys(methods).map( + (methodName) => + `/api/${moduleFieldName}.html#${methodName.toLowerCase()}` + ), + ]; + }) +); + +function assertDescription(description: string, isHtml: boolean): void { + const linkRegexp = isHtml ? /(href)="([^"]+)"/g : /\[([^\]]+)\]\(([^)]+)\)/g; + const links = [...description.matchAll(linkRegexp)].map((m) => m[2]); + + for (const link of links) { + if (!isHtml) { + expect(link).toMatch(/^https?:\/\//); + expect(link).toSatisfy(validator.isURL); + } - function resolveDirToModule(moduleName: string): string { - return resolve(tempDir, moduleName); + if (isHtml ? link.startsWith('/api/') : link.includes('fakerjs.dev/api/')) { + expect(allowedLinks, `${link} to point to a valid target`).toContain( + link.replace(/.*fakerjs.dev\//, '/') + ); + } } - - function resolvePathToMethodFile( - moduleName: string, - methodName: string - ): string { - const dir = resolveDirToModule(moduleName); - return resolve(dir, `${methodName}.ts`); +} + +// keep in sync with analyzeParameterOptions +function assertNestedParameterDefault( + name: string, + parameterType?: SomeType +): void { + if (!parameterType) { + return; } - const allowedReferences = new Set( - Object.values(modules).flatMap(([module, methods]) => { - const moduleFieldName = extractModuleFieldName(module); - return Object.keys(methods).map( - (methodName) => `faker.${moduleFieldName}.${methodName}` + switch (parameterType.type) { + case 'array': + return assertNestedParameterDefault( + `${name}[]`, + parameterType.elementType ); - }) - ); - const allowedLinks = new Set( - Object.values(modules).flatMap(([module, methods]) => { - const moduleFieldName = extractModuleFieldName(module); - return [ - `/api/${moduleFieldName}.html`, - ...Object.keys(methods).map( - (methodName) => - `/api/${moduleFieldName}.html#${methodName.toLowerCase()}` - ), - ]; - }) - ); - function assertDescription(description: string, isHtml: boolean): void { - const linkRegexp = isHtml - ? /(href)="([^"]+)"/g - : /\[([^\]]+)\]\(([^)]+)\)/g; - const links = [...description.matchAll(linkRegexp)].map((m) => m[2]); - - for (const link of links) { - if (!isHtml) { - expect(link).toMatch(/^https?:\/\//); - expect(link).toSatisfy(validator.isURL); - } - - if ( - isHtml ? link.startsWith('/api/') : link.includes('fakerjs.dev/api/') - ) { - expect(allowedLinks, `${link} to point to a valid target`).toContain( - link.replace(/.*fakerjs.dev\//, '/') - ); + case 'union': + for (const type of parameterType.types) { + assertNestedParameterDefault(name, type); } - } - } - // keep in sync with analyzeParameterOptions - function assertNestedParameterDefault( - name: string, - parameterType?: SomeType - ): void { - if (!parameterType) { return; - } - switch (parameterType.type) { - case 'array': - return assertNestedParameterDefault( - `${name}[]`, - parameterType.elementType - ); - - case 'union': - for (const type of parameterType.types) { - assertNestedParameterDefault(name, type); + case 'reflection': { + for (const property of parameterType.declaration.children ?? []) { + const reflection = property.comment + ? property + : (property.type as ReflectionType)?.declaration?.signatures?.[0]; + const comment = reflection?.comment; + const tagDefault = extractRawDefault({ comment }) || undefined; + const summaryDefault = extractSummaryDefault(comment, false); + + if (summaryDefault) { + expect( + tagDefault, + `Expect jsdoc summary default and @default for ${name}.${property.name} to be the same` + ).toBe(summaryDefault); } - - return; - - case 'reflection': { - for (const property of parameterType.declaration.children ?? []) { - const reflection = property.comment - ? property - : (property.type as ReflectionType)?.declaration?.signatures?.[0]; - const comment = reflection?.comment; - const tagDefault = extractRawDefault({ comment }) || undefined; - const summaryDefault = extractSummaryDefault(comment, false); - - if (summaryDefault) { - expect( - tagDefault, - `Expect jsdoc summary default and @default for ${name}.${property.name} to be the same` - ).toBe(summaryDefault); - } - } - - return; } - case 'typeOperator': - return assertNestedParameterDefault(name, parameterType.target); - - default: - return; + return; } + + case 'typeOperator': + return assertNestedParameterDefault(name, parameterType.target); + + default: + return; } +} +describe('verify JSDoc tags', () => { describe.each(Object.entries(modules))( '%s', (moduleName, [module, methodsByName]) => { |