diff options
Diffstat (limited to 'test/scripts')
| -rw-r--r-- | test/scripts/apidoc/signature.example.ts | 9 | ||||
| -rw-r--r-- | test/scripts/apidoc/signature.expected.json | 20 |
2 files changed, 27 insertions, 2 deletions
diff --git a/test/scripts/apidoc/signature.example.ts b/test/scripts/apidoc/signature.example.ts index 2219b072..de1cd79a 100644 --- a/test/scripts/apidoc/signature.example.ts +++ b/test/scripts/apidoc/signature.example.ts @@ -116,6 +116,15 @@ export class SignatureTest { } /** + * Test with string union. + * + * @param value `'a'` or `'b'`. + */ + stringUnionParamMethod(value: 'a' | 'b'): string { + return value; + } + + /** * Test with LiteralUnion. * * @param value `'a'` or `'b'`. diff --git a/test/scripts/apidoc/signature.expected.json b/test/scripts/apidoc/signature.expected.json index 5e4f913a..32920f78 100644 --- a/test/scripts/apidoc/signature.expected.json +++ b/test/scripts/apidoc/signature.expected.json @@ -39,12 +39,12 @@ "parameters": [ { "name": "value", - "type": "\"a\" | \"b\" | string", + "type": "'a' | 'b' | string", "description": "<p><code>'a'</code> or <code>'b'</code>.</p>\n" } ], "returns": "string", - "examples": "<div class=\"language-ts\"><pre v-pre><code>faker<span class=\"token punctuation\">.</span><span class=\"token function\">literalUnionParamMethod</span><span class=\"token punctuation\">(</span>value<span class=\"token operator\">:</span> <span class=\"token string\">\"a\"</span> <span class=\"token operator\">|</span> <span class=\"token string\">\"b\"</span> <span class=\"token operator\">|</span> <span class=\"token builtin\">string</span><span class=\"token punctuation\">)</span><span class=\"token operator\">:</span> <span class=\"token builtin\">string</span>\n</code></pre>\n</div>", + "examples": "<div class=\"language-ts\"><pre v-pre><code>faker<span class=\"token punctuation\">.</span><span class=\"token function\">literalUnionParamMethod</span><span class=\"token punctuation\">(</span>value<span class=\"token operator\">:</span> <span class=\"token string\">'a'</span> <span class=\"token operator\">|</span> <span class=\"token string\">'b'</span> <span class=\"token operator\">|</span> <span class=\"token builtin\">string</span><span class=\"token punctuation\">)</span><span class=\"token operator\">:</span> <span class=\"token builtin\">string</span>\n</code></pre>\n</div>", "deprecated": false, "seeAlsos": [] }, @@ -272,5 +272,21 @@ "examples": "<div class=\"language-ts\"><pre v-pre><code>faker<span class=\"token punctuation\">.</span><span class=\"token function\">requiredNumberParamMethod</span><span class=\"token punctuation\">(</span>a<span class=\"token operator\">:</span> <span class=\"token builtin\">number</span><span class=\"token punctuation\">)</span><span class=\"token operator\">:</span> <span class=\"token builtin\">number</span>\n</code></pre>\n</div>", "deprecated": false, "seeAlsos": [] + }, + "stringUnionParamMethod": { + "name": "stringUnionParamMethod", + "title": "String Union Param Method", + "description": "<p>Test with string union.</p>\n", + "parameters": [ + { + "name": "value", + "type": "'a' | 'b'", + "description": "<p><code>'a'</code> or <code>'b'</code>.</p>\n" + } + ], + "returns": "string", + "examples": "<div class=\"language-ts\"><pre v-pre><code>faker<span class=\"token punctuation\">.</span><span class=\"token function\">stringUnionParamMethod</span><span class=\"token punctuation\">(</span>value<span class=\"token operator\">:</span> <span class=\"token string\">'a'</span> <span class=\"token operator\">|</span> <span class=\"token string\">'b'</span><span class=\"token punctuation\">)</span><span class=\"token operator\">:</span> <span class=\"token builtin\">string</span>\n</code></pre>\n</div>", + "deprecated": false, + "seeAlsos": [] } } |
