aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--cypress/e2e/api.cy.ts2
-rw-r--r--docs/.vitepress/api-pages.ts2
-rw-r--r--docs/.vitepress/components/api-docs/method.ts1
-rw-r--r--docs/.vitepress/components/api-docs/method.vue3
-rw-r--r--docs/api/ApiIndex.vue6
-rw-r--r--scripts/apidoc.ts2
-rw-r--r--scripts/apidoc/apiDocsWriter.ts109
-rw-r--r--scripts/apidoc/fakerClass.ts48
-rw-r--r--scripts/apidoc/fakerUtilities.ts32
-rw-r--r--scripts/apidoc/generate.ts16
-rw-r--r--scripts/apidoc/moduleMethods.ts92
-rw-r--r--scripts/apidoc/signature.ts34
-rw-r--r--scripts/apidoc/utils.ts5
-rw-r--r--test/scripts/apidoc/__snapshots__/signature.spec.ts.snap57
-rw-r--r--test/scripts/apidoc/signature.debug.ts2
-rw-r--r--test/scripts/apidoc/signature.spec.ts2
-rw-r--r--test/scripts/apidoc/verify-jsdoc-tags.spec.ts24
17 files changed, 253 insertions, 184 deletions
diff --git a/cypress/e2e/api.cy.ts b/cypress/e2e/api.cy.ts
index e67ac213..be61f5df 100644
--- a/cypress/e2e/api.cy.ts
+++ b/cypress/e2e/api.cy.ts
@@ -43,7 +43,7 @@ describe('API Test', () => {
cy.request({
method: 'HEAD',
- url: `/api/${link}`,
+ url: link,
failOnStatusCode: false,
})
.should(({ status }) => {
diff --git a/docs/.vitepress/api-pages.ts b/docs/.vitepress/api-pages.ts
index dc622357..f0858635 100644
--- a/docs/.vitepress/api-pages.ts
+++ b/docs/.vitepress/api-pages.ts
@@ -2,6 +2,7 @@
// Run 'pnpm run generate:api-docs' to update
export const apiPages = [
{ text: 'Overview', link: '/api/' },
+ { text: 'Faker', link: '/api/faker.html' },
{ text: 'Airline', link: '/api/airline.html' },
{ text: 'Animal', link: '/api/animal.html' },
{ text: 'Color', link: '/api/color.html' },
@@ -28,4 +29,5 @@ export const apiPages = [
{ text: 'System', link: '/api/system.html' },
{ text: 'Vehicle', link: '/api/vehicle.html' },
{ text: 'Word', link: '/api/word.html' },
+ { text: 'Utilities', link: '/api/utils.html' },
];
diff --git a/docs/.vitepress/components/api-docs/method.ts b/docs/.vitepress/components/api-docs/method.ts
index 562d1ecf..6601a5ca 100644
--- a/docs/.vitepress/components/api-docs/method.ts
+++ b/docs/.vitepress/components/api-docs/method.ts
@@ -1,6 +1,5 @@
export interface Method {
readonly name: string;
- readonly title: string;
readonly description: string; // HTML
readonly parameters: MethodParameter[];
readonly returns: string;
diff --git a/docs/.vitepress/components/api-docs/method.vue b/docs/.vitepress/components/api-docs/method.vue
index 6753cefd..38d10586 100644
--- a/docs/.vitepress/components/api-docs/method.vue
+++ b/docs/.vitepress/components/api-docs/method.vue
@@ -8,6 +8,9 @@ const props = defineProps<{ method: Method }>();
function seeAlsoToUrl(see: string): string {
const [, module, method] = see.replace(/\(.*/, '').split('\.');
+ if (!method) {
+ return 'faker.html#' + slugify(module);
+ }
return module + '.html#' + slugify(method);
}
</script>
diff --git a/docs/api/ApiIndex.vue b/docs/api/ApiIndex.vue
index 55efaeca..6500ae69 100644
--- a/docs/api/ApiIndex.vue
+++ b/docs/api/ApiIndex.vue
@@ -97,13 +97,11 @@ onUnmounted(() => window.removeEventListener('keydown', apiSearchFocusHandler));
<div class="api-groups">
<div v-for="item of section.items" :key="item.text" class="api-group">
<h3>
- <a :href="item.link + '.html'">{{ item.text }}</a>
+ <a :href="item.link">{{ item.text }}</a>
</h3>
<ul>
<li v-for="h of item.headers" :key="h.anchor">
- <a :href="item.link + '.html#' + slugify(h.anchor)">{{
- h.text
- }}</a>
+ <a :href="item.link + '#' + slugify(h.anchor)">{{ h.text }}</a>
</li>
</ul>
</div>
diff --git a/scripts/apidoc.ts b/scripts/apidoc.ts
index 3c448f8b..ecb1f8fe 100644
--- a/scripts/apidoc.ts
+++ b/scripts/apidoc.ts
@@ -1,10 +1,8 @@
-import { faker } from '../src';
import { generate } from './apidoc/generate';
import { initMarkdownRenderer } from './apidoc/signature';
async function build(): Promise<void> {
await initMarkdownRenderer();
- faker.setDefaultRefDate(Date.UTC(2023, 0, 1));
await generate();
}
diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts
index 6f00f64a..ba1e4367 100644
--- a/scripts/apidoc/apiDocsWriter.ts
+++ b/scripts/apidoc/apiDocsWriter.ts
@@ -2,16 +2,17 @@ import { writeFileSync } from 'node:fs';
import { resolve } from 'node:path';
import type { ProjectReflection } from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import type { APIGroup, APIItem } from '../../docs/api/api-types';
+import type { APIGroup } from '../../docs/api/api-types';
import { formatMarkdown, formatTypescript } from './format';
+import { extractSourceBaseUrl } from './typedoc';
+import type { DocsApiDiffIndex, ModuleSummary, Page } from './utils';
import {
- extractModuleName,
- extractSourceBaseUrl,
- selectApiMethods,
- selectApiModules,
-} from './typedoc';
-import type { DocsApiDiffIndex, PageIndex } from './utils';
-import { pathDocsDiffIndexFile, pathDocsDir, pathOutputDir } from './utils';
+ diffHash,
+ methodDiffHash,
+ pathDocsDiffIndexFile,
+ pathDocsDir,
+ pathOutputDir,
+} from './utils';
const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.ts');
const pathDocsApiSearchIndex = resolve(
@@ -30,6 +31,52 @@ editLink: false
`;
/**
+ * Writes the api docs for the given modules.
+ *
+ * @param moduleName The name of the module to write the docs for.
+ * @param lowerModuleName The lowercase name of the module.
+ * @param comment The module comments.
+ * @param deprecated The deprecation message.
+ * @param methods The methods of the module.
+ */
+export function writeApiDocsModule(
+ moduleName: string,
+ lowerModuleName: string,
+ comment: string,
+ deprecated: string | undefined,
+ methods: Method[]
+): ModuleSummary {
+ writeApiDocsModulePage(
+ moduleName,
+ lowerModuleName,
+ comment,
+ deprecated,
+ methods
+ );
+ writeApiDocsModuleData(lowerModuleName, methods);
+
+ return {
+ text: moduleName,
+ link: `/api/${lowerModuleName}.html`,
+ methods,
+ diff: methods.reduce(
+ (data, method) => ({
+ ...data,
+ [method.name]: methodDiffHash(method),
+ }),
+ {
+ moduleHash: diffHash({
+ name: moduleName,
+ field: lowerModuleName,
+ deprecated,
+ comment,
+ }),
+ }
+ ),
+ };
+}
+
+/**
* Writes the api page for the given module to the correct location.
*
* @param moduleName The name of the module to write the docs for.
@@ -37,7 +84,7 @@ editLink: false
* @param comment The module comments.
* @param methods The methods of the module.
*/
-export function writeApiDocsModulePage(
+function writeApiDocsModulePage(
moduleName: string,
lowerModuleName: string,
comment: string,
@@ -94,7 +141,7 @@ export function writeApiDocsModulePage(
* @param lowerModuleName The lowercase name of the module.
* @param methods The methods data to save.
*/
-export function writeApiDocsData(
+function writeApiDocsModuleData(
lowerModuleName: string,
methods: Method[]
): void {
@@ -116,10 +163,9 @@ export function writeApiDocsData(
*
* @param pages The pages to write into the index.
*/
-export function writeApiPagesIndex(pages: PageIndex): void {
+export function writeApiPagesIndex(pages: Page[]): void {
// Write api-pages.ts
console.log('Updating api-pages.ts');
- pages.sort((a, b) => a.text.localeCompare(b.text));
pages.splice(0, 0, { text: 'Overview', link: '/api/' });
let apiPagesContent = `
// This file is automatically generated.
@@ -146,33 +192,20 @@ export function writeApiDiffIndex(diffIndex: DocsApiDiffIndex): void {
*
* @param project The typedoc project.
*/
-export function writeApiSearchIndex(project: ProjectReflection): void {
- const apiIndex: APIGroup[] = [];
-
- const moduleApiSection: APIGroup = {
- text: 'Module API',
- items: [],
- };
-
- apiIndex.push(moduleApiSection);
-
- const apiModules = selectApiModules(project);
-
- moduleApiSection.items = apiModules
- .map((module) => {
- const moduleName = extractModuleName(module);
- const apiSection: APIItem = {
- text: moduleName,
- link: moduleName.toLowerCase(),
- headers: selectApiMethods(module).map((child) => ({
- anchor: child.name,
- text: child.name,
+export function writeApiSearchIndex(pages: ModuleSummary[]): void {
+ const apiIndex: APIGroup[] = [
+ {
+ text: 'Module API',
+ items: pages.map((module) => ({
+ text: module.text,
+ link: module.link,
+ headers: module.methods.map((method) => ({
+ anchor: method.name,
+ text: method.name,
})),
- };
-
- return apiSection;
- })
- .sort((a, b) => a.text.localeCompare(b.text));
+ })),
+ },
+ ];
writeFileSync(pathDocsApiSearchIndex, JSON.stringify(apiIndex));
}
diff --git a/scripts/apidoc/fakerClass.ts b/scripts/apidoc/fakerClass.ts
new file mode 100644
index 00000000..9d11815f
--- /dev/null
+++ b/scripts/apidoc/fakerClass.ts
@@ -0,0 +1,48 @@
+import type { DeclarationReflection, ProjectReflection } from 'typedoc';
+import { ReflectionKind } from 'typedoc';
+import type { Method } from '../../docs/.vitepress/components/api-docs/method';
+import { writeApiDocsModule } from './apiDocsWriter';
+import { processModuleMethods } from './moduleMethods';
+import { analyzeSignature, toBlock } from './signature';
+import { selectApiSignature } from './typedoc';
+import type { ModuleSummary } from './utils';
+
+export function processFakerClass(project: ProjectReflection): ModuleSummary {
+ const fakerClass = project
+ .getChildrenByKind(ReflectionKind.Class)
+ .filter((clazz) => clazz.name === 'Faker')[0];
+
+ if (!fakerClass) {
+ throw new Error('Faker class not found');
+ }
+
+ return processClass(fakerClass);
+}
+
+function processClass(fakerClass: DeclarationReflection): ModuleSummary {
+ console.log(`Processing Faker class`);
+ const comment = toBlock(fakerClass.comment);
+ const methods: Method[] = [];
+
+ console.debug(`- constructor`);
+ methods.push(processConstructor(fakerClass));
+
+ methods.push(...processModuleMethods(fakerClass, 'faker.'));
+
+ return writeApiDocsModule('Faker', 'faker', comment, undefined, methods);
+}
+
+function processConstructor(fakerClass: DeclarationReflection): Method {
+ const constructor = fakerClass.getChildrenByKind(
+ ReflectionKind.Constructor
+ )[0];
+
+ const signature = selectApiSignature(constructor);
+
+ const method = analyzeSignature(signature, '', 'new Faker');
+
+ return {
+ ...method,
+ name: 'constructor',
+ };
+}
diff --git a/scripts/apidoc/fakerUtilities.ts b/scripts/apidoc/fakerUtilities.ts
new file mode 100644
index 00000000..f033eadc
--- /dev/null
+++ b/scripts/apidoc/fakerUtilities.ts
@@ -0,0 +1,32 @@
+import type { DeclarationReflection, ProjectReflection } from 'typedoc';
+import { ReflectionKind } from 'typedoc';
+import type { Method } from '../../docs/.vitepress/components/api-docs/method';
+import { writeApiDocsModule } from './apiDocsWriter';
+import { processMethods } from './moduleMethods';
+import { selectApiSignature } from './typedoc';
+import type { ModuleSummary } from './utils';
+
+export function processFakerUtilities(
+ project: ProjectReflection
+): ModuleSummary {
+ const fakerUtilities = project
+ .getChildrenByKind(ReflectionKind.Function)
+ .filter((method) => !method.flags.isPrivate);
+
+ return processUtilities(fakerUtilities);
+}
+
+function processUtilities(
+ fakerUtilities: DeclarationReflection[]
+): ModuleSummary {
+ console.log(`Processing Faker Utilities`);
+ const comment = 'A list of all the utilities available in Faker.js.';
+
+ const methods: Method[] = processMethods(
+ Object.fromEntries(
+ fakerUtilities.map((method) => [method.name, selectApiSignature(method)])
+ )
+ );
+
+ return writeApiDocsModule('Utilities', 'utils', comment, undefined, methods);
+}
diff --git a/scripts/apidoc/generate.ts b/scripts/apidoc/generate.ts
index b5ccb3f3..408ab76a 100644
--- a/scripts/apidoc/generate.ts
+++ b/scripts/apidoc/generate.ts
@@ -5,7 +5,9 @@ import {
writeApiSearchIndex,
writeSourceBaseUrl,
} from './apiDocsWriter';
-import { processModuleMethods } from './moduleMethods';
+import { processFakerClass } from './fakerClass';
+import { processFakerUtilities } from './fakerUtilities';
+import { processModules } from './moduleMethods';
import { loadProject } from './typedoc';
import { pathOutputDir } from './utils';
@@ -20,12 +22,16 @@ export async function generate(): Promise<void> {
// Useful for manually analyzing the content
await app.generateJson(project, pathOutputJson);
- const modules = processModuleMethods(project);
- writeApiPagesIndex(modules.map(({ text, link }) => ({ text, link })));
+ const pages = [
+ processFakerClass(project),
+ ...processModules(project).sort((a, b) => a.text.localeCompare(b.text)),
+ processFakerUtilities(project),
+ ];
+ writeApiPagesIndex(pages.map(({ text, link }) => ({ text, link })));
writeApiDiffIndex(
- modules.reduce((data, { text, diff }) => ({ ...data, [text]: diff }), {})
+ pages.reduce((data, { text, diff }) => ({ ...data, [text]: diff }), {})
);
+ writeApiSearchIndex(pages);
- writeApiSearchIndex(project);
writeSourceBaseUrl(project);
}
diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts
index 20cbc2b8..9c902dd7 100644
--- a/scripts/apidoc/moduleMethods.ts
+++ b/scripts/apidoc/moduleMethods.ts
@@ -1,6 +1,10 @@
-import type { DeclarationReflection, ProjectReflection } from 'typedoc';
+import type {
+ DeclarationReflection,
+ ProjectReflection,
+ SignatureReflection,
+} from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter';
+import { writeApiDocsModule } from './apiDocsWriter';
import { analyzeSignature, stripAbsoluteFakerUrls, toBlock } from './signature';
import {
extractDeprecated,
@@ -9,8 +13,7 @@ import {
selectApiMethodSignatures,
selectApiModules,
} from './typedoc';
-import type { PageAndDiffIndex } from './utils';
-import { diffHash, methodDiffHash } from './utils';
+import type { ModuleSummary } from './utils';
/**
* Analyzes and writes the documentation for modules and their methods such as `faker.animal.cat()`.
@@ -18,17 +21,8 @@ import { diffHash, methodDiffHash } from './utils';
* @param project The project used to extract the modules.
* @returns The generated pages.
*/
-export function processModuleMethods(
- project: ProjectReflection
-): PageAndDiffIndex {
- const pages: PageAndDiffIndex = [];
-
- // Generate module files
- for (const module of selectApiModules(project)) {
- pages.push(...processModuleMethod(module));
- }
-
- return pages;
+export function processModules(project: ProjectReflection): ModuleSummary[] {
+ return selectApiModules(project).map(processModule);
}
/**
@@ -37,48 +31,54 @@ export function processModuleMethods(
* @param module The module to process.
* @returns The generated pages.
*/
-function processModuleMethod(module: DeclarationReflection): PageAndDiffIndex {
+function processModule(module: DeclarationReflection): ModuleSummary {
const moduleName = extractModuleName(module);
const moduleFieldName = extractModuleFieldName(module);
console.log(`Processing Module ${moduleName}`);
const comment = stripAbsoluteFakerUrls(toBlock(module.comment));
const deprecated = extractDeprecated(module);
- const methods: Method[] = [];
-
- // Generate method section
- for (const [methodName, signature] of Object.entries(
- selectApiMethodSignatures(module)
- )) {
- console.debug(`- ${methodName}`);
- methods.push(analyzeSignature(signature, moduleFieldName, methodName));
- }
+ const methods = processModuleMethods(module, `faker.${moduleFieldName}.`);
- writeApiDocsModulePage(
+ return writeApiDocsModule(
moduleName,
moduleFieldName,
comment,
deprecated,
methods
);
- writeApiDocsData(moduleFieldName, methods);
+}
+
+/**
+ * Processes all api methods of the given class. This does not include the constructor.
+ *
+ * @param module The module to process.
+ * @param accessor The code used to access the methods within the module.
+ * @returns A list containing the documentation for the api methods in the given module.
+ */
+export function processModuleMethods(
+ module: DeclarationReflection,
+ accessor: string
+): Method[] {
+ return processMethods(selectApiMethodSignatures(module), accessor);
+}
+
+/**
+ * Processes all api methods.
+ *
+ * @param signatures The signatures to process.
+ * @param accessor The code used to access the methods.
+ * @returns A list containing the documentation for the api methods.
+ */
+export function processMethods(
+ signatures: Record<string, SignatureReflection>,
+ accessor: string = ''
+): Method[] {
+ const methods: Method[] = [];
+
+ for (const [methodName, signature] of Object.entries(signatures)) {
+ console.debug(`- ${methodName}`);
+ methods.push(analyzeSignature(signature, accessor, methodName));
+ }
- return [
- {
- text: moduleName,
- link: `/api/${moduleFieldName}.html`,
- diff: methods.reduce(
- (data, method) => ({
- ...data,
- [method.name]: methodDiffHash(method),
- }),
- {
- moduleHash: diffHash({
- name: moduleName,
- field: moduleFieldName,
- comment,
- }),
- }
- ),
- },
- ];
+ return methods;
}
diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts
index f9364a04..113aba1d 100644
--- a/scripts/apidoc/signature.ts
+++ b/scripts/apidoc/signature.ts
@@ -17,7 +17,6 @@ import type {
MethodParameter,
} from '../../docs/.vitepress/components/api-docs/method';
import vitepressConfig from '../../docs/.vitepress/config';
-import { faker } from '../../src';
import { formatTypescript } from './format';
import {
extractDeprecated,
@@ -32,14 +31,6 @@ import { pathOutputDir } from './utils';
const code = '```';
-function prettifyMethodName(method: string): string {
- return (
- // Capitalize and insert space before upper case characters
- method.substring(0, 1).toUpperCase() +
- method.substring(1).replace(/([A-Z]+)/g, ' $1')
- );
-}
-
export const MISSING_DESCRIPTION = 'Missing';
export function toBlock(comment?: Comment): string {
@@ -115,7 +106,7 @@ function mdToHtml(md: string, inline: boolean = false): string {
export function analyzeSignature(
signature: SignatureReflection,
- moduleName: string | null,
+ accessor: string,
methodName: string
): Method {
const parameters: MethodParameter[] = [];
@@ -155,27 +146,7 @@ export function analyzeSignature(
const signatureParametersString = signatureParameters.join(', ');
- let examples: string;
- if (moduleName) {
- examples = `faker.${moduleName}.${methodName}${signatureTypeParametersString}(${signatureParametersString}): ${signature.type?.toString()}\n`;
- } else {
- examples = `faker.${methodName}${signatureTypeParametersString}(${signatureParametersString}): ${signature.type?.toString()}\n`;
- }
-
- faker.seed(0);
- if (moduleName) {
- try {
- let example = JSON.stringify(faker[moduleName][methodName]());
- if (example.length > 50) {
- example = `${example.substring(0, 47)}...`;
- }
-
- examples += `faker.${moduleName}.${methodName}()`;
- examples += `${example ? ` // => ${example}` : ''}\n`;
- } catch (error) {
- // Ignore the error => hide the example call + result.
- }
- }
+ let examples = `${accessor}${methodName}${signatureTypeParametersString}(${signatureParametersString}): ${signature.type?.toString()}\n`;
const exampleTags = extractRawExamples(signature);
if (exampleTags.length > 0) {
@@ -191,7 +162,6 @@ export function analyzeSignature(
: undefined;
return {
name: methodName,
- title: prettifyMethodName(methodName),
description: mdToHtml(toBlock(signature.comment)),
parameters: parameters,
since: extractSince(signature),
diff --git a/scripts/apidoc/utils.ts b/scripts/apidoc/utils.ts
index 4c9c322d..79e47507 100644
--- a/scripts/apidoc/utils.ts
+++ b/scripts/apidoc/utils.ts
@@ -5,12 +5,11 @@ import type { Method } from '../../docs/.vitepress/components/api-docs/method';
// Types
export type Page = { text: string; link: string };
-export type PageIndex = Page[];
-export type PageAndDiff = Page & {
+export type ModuleSummary = Page & {
+ methods: Method[];
diff: DocsApiDiff;
};
-export type PageAndDiffIndex = PageAndDiff[];
export interface DocsApiDiffIndex {
/**
diff --git a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap
index f93bcd49..715c85aa 100644
--- a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap
+++ b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap
@@ -5,7 +5,7 @@ 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">complexArrayParameter</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#FFCB6B\\">T</span><span style=\\"color:#89DDFF\\">&gt;</span><span style=\\"color:#A6ACCD\\">(array: readonly </span><span style=\\"color:#82AAFF\\">Array</span><span style=\\"color:#89DDFF\\">&lt;{</span></span>
+ "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\\">&lt;</span><span style=\\"color:#FFCB6B\\">T</span><span style=\\"color:#89DDFF\\">&gt;</span><span style=\\"color:#A6ACCD\\">(array: readonly </span><span style=\\"color:#82AAFF\\">Array</span><span style=\\"color:#89DDFF\\">&lt;{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FFCB6B\\">T</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">weight</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FFCB6B\\">number</span></span>
<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}&gt;</span><span style=\\"color:#A6ACCD\\">): T</span></span>
@@ -45,7 +45,6 @@ exports[`signature > analyzeSignature() > complexArrayParameter 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L343",
- "title": "Complex Array Parameter",
}
`;
@@ -54,7 +53,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">defaultBooleanParamMethod</span><span style=\\"color:#A6ACCD\\">(c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#A6ACCD\\">): number</span></span>
+ "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:#A6ACCD\\">(c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#A6ACCD\\">): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "defaultBooleanParamMethod",
@@ -71,7 +70,6 @@ exports[`signature > analyzeSignature() > defaultBooleanParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L101",
- "title": "Default Boolean Param Method",
}
`;
@@ -104,7 +102,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">functionParamMethod</span><span style=\\"color:#A6ACCD\\">(fn: </span><span style=\\"color:#89DDFF\\">(</span><span style=\\"color:#A6ACCD;font-style:italic\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FFCB6B\\">string</span><span style=\\"color:#89DDFF\\">)</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#C792EA\\">=&gt;</span><span style=\\"color:#A6ACCD\\"> number): number</span></span>
+ "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:#A6ACCD\\">(fn: </span><span style=\\"color:#89DDFF\\">(</span><span style=\\"color:#A6ACCD;font-style:italic\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FFCB6B\\">string</span><span style=\\"color:#89DDFF\\">)</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#C792EA\\">=&gt;</span><span style=\\"color:#A6ACCD\\"> number): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "functionParamMethod",
@@ -121,7 +119,6 @@ exports[`signature > analyzeSignature() > functionParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L121",
- "title": "Function Param Method",
}
`;
@@ -130,7 +127,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">literalUnionParamMethod</span><span style=\\"color:#A6ACCD\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> namedValue: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> array: readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> namedArray: readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> mixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> namedMixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;</span><span style=\\"color:#A6ACCD\\">): string</span></span>
+ "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:#A6ACCD\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> namedValue: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> array: readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> namedArray: readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> mixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;,</span><span style=\\"color:#A6ACCD\\"> namedMixed: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> readonly Array</span><span style=\\"color:#89DDFF\\">&lt;</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">b</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">&gt;</span><span style=\\"color:#A6ACCD\\">): string</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "literalUnionParamMethod",
@@ -182,7 +179,6 @@ exports[`signature > analyzeSignature() > literalUnionParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L155",
- "title": "Literal Union Param Method",
}
`;
@@ -192,7 +188,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithDeprecated</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "methodWithDeprecated",
@@ -203,7 +199,6 @@ exports[`signature > analyzeSignature() > methodWithDeprecated 1`] = `
],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L273",
- "title": "Method With Deprecated",
}
`;
@@ -212,7 +207,7 @@ 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithDeprecatedOption</span><span style=\\"color:#A6ACCD\\">(option: </span><span style=\\"color:#89DDFF\\">{</span></span>
+ "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:#A6ACCD\\">(option: </span><span style=\\"color:#89DDFF\\">{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#82AAFF\\">b</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">()</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#C792EA\\">=&gt;</span><span style=\\"color:#A6ACCD\\"> number</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">c</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> number</span></span>
@@ -256,7 +251,6 @@ exports[`signature > analyzeSignature() > methodWithDeprecatedOption 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L285",
- "title": "Method With Deprecated Option",
}
`;
@@ -265,7 +259,7 @@ 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithExample</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\">test</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#A6ACCD\\">apidoc</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithExample</span><span style=\\"color:#A6ACCD\\">() </span><span style=\\"color:#676E95;font-style:italic\\">// 0</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
@@ -275,7 +269,6 @@ exports[`signature > analyzeSignature() > methodWithExample 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L262",
- "title": "Method With Example",
}
`;
@@ -284,7 +277,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithMultipleSeeMarkers</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "methodWithMultipleSeeMarkers",
@@ -296,7 +289,6 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkers 1`] = `
],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L312",
- "title": "Method With Multiple See Markers",
}
`;
@@ -305,7 +297,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithMultipleSeeMarkersAndBackticks</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "methodWithMultipleSeeMarkersAndBackticks",
@@ -317,7 +309,6 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkersAndBacktic
],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L322",
- "title": "Method With Multiple See Markers And Backticks",
}
`;
@@ -326,7 +317,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">methodWithSinceMarker</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "methodWithSinceMarker",
@@ -335,7 +326,6 @@ exports[`signature > analyzeSignature() > methodWithSinceMarker 1`] = `
"seeAlsos": [],
"since": "1.0.0",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L331",
- "title": "Method With Since Marker",
}
`;
@@ -344,7 +334,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">multiParamMethod</span><span style=\\"color:#A6ACCD\\">(a: number</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#A6ACCD\\">): number</span></span>
+ "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:#A6ACCD\\">(a: number</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span><span style=\\"color:#A6ACCD\\"> c: boolean </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#FF9CAC\\">true</span><span style=\\"color:#A6ACCD\\">): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "multiParamMethod",
@@ -375,7 +365,6 @@ exports[`signature > analyzeSignature() > multiParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L112",
- "title": "Multi Param Method",
}
`;
@@ -384,7 +373,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">noParamMethod</span><span style=\\"color:#A6ACCD\\">(): number</span></span>
+ "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:#A6ACCD\\">(): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "noParamMethod",
@@ -393,7 +382,6 @@ exports[`signature > analyzeSignature() > noParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L74",
- "title": "No Param Method",
}
`;
@@ -402,7 +390,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">optionalStringParamMethod</span><span style=\\"color:#A6ACCD\\">(b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> string): number</span></span>
+ "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:#A6ACCD\\">(b</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> string): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "optionalStringParamMethod",
@@ -419,7 +407,6 @@ exports[`signature > analyzeSignature() > optionalStringParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L92",
- "title": "Optional String Param Method",
}
`;
@@ -428,7 +415,7 @@ 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">optionsInlineParamMethodWithDefaults</span><span style=\\"color:#A6ACCD\\">(a: </span><span style=\\"color:#89DDFF\\">{</span></span>
+ "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:#A6ACCD\\">(a: </span><span style=\\"color:#89DDFF\\">{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> number</span></span>
<span class=\\"line\\"><span style=\\"color:#89DDFF\\">}</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> b: </span><span style=\\"color:#89DDFF\\">{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> number</span></span>
@@ -488,7 +475,6 @@ It also has a more complex description.</p>
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L212",
- "title": "Options Inline Param Method With Defaults",
}
`;
@@ -497,7 +483,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">optionsInterfaceParamMethodWithDefaults</span><span style=\\"color:#A6ACCD\\">(a: ParameterOptionsInterfaceA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> b: ParameterOptionsInterfaceB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> c: ParameterOptionsInterfaceC): number</span></span>
+ "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:#A6ACCD\\">(a: ParameterOptionsInterfaceA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> b: ParameterOptionsInterfaceB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> c: ParameterOptionsInterfaceC): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "optionsInterfaceParamMethodWithDefaults",
@@ -528,7 +514,6 @@ exports[`signature > analyzeSignature() > optionsInterfaceParamMethodWithDefault
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L248",
- "title": "Options Interface Param Method With Defaults",
}
`;
@@ -537,7 +522,7 @@ exports[`signature > analyzeSignature() > optionsParamMethod 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">optionsParamMethod</span><span style=\\"color:#A6ACCD\\">(options: </span><span style=\\"color:#89DDFF\\">{</span></span>
+ "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:#A6ACCD\\">(options: </span><span style=\\"color:#89DDFF\\">{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">a</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> number</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">b</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> string</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">c</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> boolean</span><span style=\\"color:#89DDFF\\">,</span></span>
@@ -595,7 +580,6 @@ exports[`signature > analyzeSignature() > optionsParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L182",
- "title": "Options Param Method",
}
`;
@@ -604,7 +588,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">optionsTypeParamMethodWithDefaults</span><span style=\\"color:#A6ACCD\\">(a: ParameterOptionsTypeA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> b: ParameterOptionsTypeB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> c: ParameterOptionsTypeC): number</span></span>
+ "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:#A6ACCD\\">(a: ParameterOptionsTypeA </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> b: ParameterOptionsTypeB </span><span style=\\"color:#89DDFF\\">=</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">value</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F78C6C\\">1</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">},</span><span style=\\"color:#A6ACCD\\"> c: ParameterOptionsTypeC): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "optionsTypeParamMethodWithDefaults",
@@ -635,7 +619,6 @@ exports[`signature > analyzeSignature() > optionsTypeParamMethodWithDefaults 1`]
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L230",
- "title": "Options Type Param Method With Defaults",
}
`;
@@ -644,7 +627,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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">requiredNumberParamMethod</span><span style=\\"color:#A6ACCD\\">(a: number): number</span></span>
+ "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:#A6ACCD\\">(a: number): number</span></span>
<span class=\\"line\\"></span></code></pre>
</div>",
"name": "requiredNumberParamMethod",
@@ -661,7 +644,6 @@ exports[`signature > analyzeSignature() > requiredNumberParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L83",
- "title": "Required Number Param Method",
}
`;
@@ -670,7 +652,7 @@ 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:#A6ACCD\\">faker</span><span style=\\"color:#89DDFF\\">.</span><span style=\\"color:#82AAFF\\">stringUnionParamMethod</span><span style=\\"color:#A6ACCD\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </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:#A6ACCD\\"> options</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span></span>
+ "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:#A6ACCD\\">(value: </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">a</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </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:#A6ACCD\\"> options</span><span style=\\"color:#89DDFF\\">?:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">{</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">casing</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">lower</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">mixed</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </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:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">excludes</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> readonly AlphaNumericChar[]</span><span style=\\"color:#89DDFF\\">,</span></span>
<span class=\\"line\\"><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#F07178\\">format</span><span style=\\"color:#89DDFF\\">:</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">binary</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">css</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">decimal</span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">|</span><span style=\\"color:#A6ACCD\\"> </span><span style=\\"color:#89DDFF\\">'</span><span style=\\"color:#C3E88D\\">hex</span><span style=\\"color:#89DDFF\\">'</span></span>
@@ -719,6 +701,5 @@ exports[`signature > analyzeSignature() > stringUnionParamMethod 1`] = `
"seeAlsos": [],
"since": "",
"sourcePath": "test/scripts/apidoc/signature.example.ts#L134",
- "title": "String Union Param Method",
}
`;
diff --git a/test/scripts/apidoc/signature.debug.ts b/test/scripts/apidoc/signature.debug.ts
index 6be0e49f..0076dfa7 100644
--- a/test/scripts/apidoc/signature.debug.ts
+++ b/test/scripts/apidoc/signature.debug.ts
@@ -16,7 +16,7 @@ initMarkdownRenderer()
.then(() => {
Object.entries(methods).forEach(([name, method]) => {
console.log('Analyzing: ', name);
- const result = analyzeSignature(method, null, method.name);
+ const result = analyzeSignature(method, '', method.name);
console.log('Result: ', result);
});
})
diff --git a/test/scripts/apidoc/signature.spec.ts b/test/scripts/apidoc/signature.spec.ts
index d90370a2..3a48c29b 100644
--- a/test/scripts/apidoc/signature.spec.ts
+++ b/test/scripts/apidoc/signature.spec.ts
@@ -23,7 +23,7 @@ describe('signature', () => {
});
it.each(Object.entries(methods))('%s', (name, signature) => {
- const actual = analyzeSignature(signature, null, name);
+ const actual = analyzeSignature(signature, '', name);
expect(actual).toMatchSnapshot();
});
diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
index 410bffc2..68692fab 100644
--- a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
+++ b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts
@@ -109,18 +109,18 @@ describe('verify JSDoc tags', () => {
});
it('verify @param tags', () => {
- analyzeSignature(
- signature,
- moduleName,
- methodName
- ).parameters.forEach((param) => {
- const { name, description } = param;
- const plainDescription = description.replace(/<[^>]+>/g, '').trim();
- expect(
- plainDescription,
- `Expect param ${name} to have a description`
- ).not.toBe(MISSING_DESCRIPTION);
- });
+ analyzeSignature(signature, '', methodName).parameters.forEach(
+ (param) => {
+ const { name, description } = param;
+ const plainDescription = description
+ .replace(/<[^>]+>/g, '')
+ .trim();
+ expect(
+ plainDescription,
+ `Expect param ${name} to have a description`
+ ).not.toBe(MISSING_DESCRIPTION);
+ }
+ );
});
it('verify @see tags', () => {
generated by cgit v1.2.3 (git 2.25.1) at 2026-06-06 05:17:19 +0000