From 5b689f9b316c2a5bda35daf9dab06d3413e57c3a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 12 Apr 2023 22:30:24 +0200 Subject: chore(deps): update doc-dependencies (#2037) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: ST-DDT --- package.json | 6 +- pnpm-lock.yaml | 40 ++++++------- scripts/apidoc/apiDocsWriter.ts | 5 +- scripts/apidoc/signature.ts | 4 +- scripts/apidoc/typedoc.ts | 54 ++++++++++++++---- .../apidoc/__snapshots__/signature.spec.ts.snap | 65 ++++++++-------------- 6 files changed, 95 insertions(+), 79 deletions(-) diff --git a/package.json b/package.json index 2bb6e10e..08e14428 100644 --- a/package.json +++ b/package.json @@ -91,7 +91,7 @@ "@types/markdown-it": "~12.2.3", "@types/node": "~18.15.11", "@types/prettier": "~2.7.2", - "@types/react": "~18.0.32", + "@types/react": "~18.0.35", "@types/sanitize-html": "~2.9.0", "@types/semver": "~7.3.13", "@types/validator": "~13.7.14", @@ -123,12 +123,12 @@ "semver": "~7.4.0", "standard-version": "~9.5.0", "tsx": "~3.12.6", - "typedoc": "~0.23.28", + "typedoc": "~0.24.1", "typedoc-plugin-missing-exports": "~1.0.0", "typescript": "~4.9.5", "validator": "~13.9.0", "vite": "~4.2.1", - "vitepress": "1.0.0-alpha.64", + "vitepress": "1.0.0-alpha.65", "vitest": "~0.30.1", "vue": "~3.2.47" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a2d912e7..afe224d6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,8 +20,8 @@ devDependencies: specifier: ~2.7.2 version: 2.7.2 '@types/react': - specifier: ~18.0.32 - version: 18.0.32 + specifier: ~18.0.35 + version: 18.0.35 '@types/sanitize-html': specifier: ~2.9.0 version: 2.9.0 @@ -116,11 +116,11 @@ devDependencies: specifier: ~3.12.6 version: 3.12.6 typedoc: - specifier: ~0.23.28 - version: 0.23.28(typescript@4.9.5) + specifier: ~0.24.1 + version: 0.24.1(typescript@4.9.5) typedoc-plugin-missing-exports: specifier: ~1.0.0 - version: 1.0.0(typedoc@0.23.28) + version: 1.0.0(typedoc@0.24.1) typescript: specifier: ~4.9.5 version: 4.9.5 @@ -131,8 +131,8 @@ devDependencies: specifier: ~4.2.1 version: 4.2.1(@types/node@18.15.11) vitepress: - specifier: 1.0.0-alpha.64 - version: 1.0.0-alpha.64(@algolia/client-search@4.17.0)(@types/node@18.15.11)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0) + specifier: 1.0.0-alpha.65 + version: 1.0.0-alpha.65(@algolia/client-search@4.17.0)(@types/node@18.15.11)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0) vitest: specifier: ~0.30.1 version: 0.30.1(@vitest/ui@0.30.1) @@ -361,10 +361,10 @@ packages: resolution: {integrity: sha512-6SCwI7P8ao+se1TUsdZ7B4XzL+gqeQZnBc+2EONZlcVa0dVrk0NjETxozFKgMv0eEGH8QzP1fkN+A1rH61l4eg==} dev: true - /@docsearch/js@3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0): + /@docsearch/js@3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0): resolution: {integrity: sha512-2xAv2GFuHzzmG0SSZgf8wHX0qZX8n9Y1ZirKUk5Wrdc+vH9CL837x2hZIUdwcPZI9caBA+/CzxsS68O4waYjUQ==} dependencies: - '@docsearch/react': 3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0) + '@docsearch/react': 3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0) preact: 10.13.2 transitivePeerDependencies: - '@algolia/client-search' @@ -373,7 +373,7 @@ packages: - react-dom dev: true - /@docsearch/react@3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0): + /@docsearch/react@3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0): resolution: {integrity: sha512-pLa0cxnl+G0FuIDuYlW+EBK6Rw2jwLw9B1RHIeS4N4s2VhsfJ/wzeCi3CWcs5yVfxLd5ZK50t//TMA5e79YT7Q==} peerDependencies: '@types/react': '>= 16.8.0 < 19.0.0' @@ -390,7 +390,7 @@ packages: '@algolia/autocomplete-core': 1.7.4 '@algolia/autocomplete-preset-algolia': 1.7.4(@algolia/client-search@4.17.0)(algoliasearch@4.17.0) '@docsearch/css': 3.3.3 - '@types/react': 18.0.32 + '@types/react': 18.0.35 algoliasearch: 4.17.0 react: 18.2.0 react-dom: 18.2.0(react@18.2.0) @@ -894,8 +894,8 @@ packages: resolution: {integrity: sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==} dev: true - /@types/react@18.0.32: - resolution: {integrity: sha512-gYGXdtPQ9Cj0w2Fwqg5/ak6BcK3Z15YgjSqtyDizWUfx7mQ8drs0NBUzRRsAdoFVTO8kJ8L2TL8Skm7OFPnLUw==} + /@types/react@18.0.35: + resolution: {integrity: sha512-6Laome31HpetaIUGFWl1VQ3mdSImwxtFZ39rh059a1MNnKGqBpC88J6NJ8n/Is3Qx7CefDGLgf/KhN/sYCf7ag==} dependencies: '@types/prop-types': 15.7.5 '@types/scheduler': 0.16.3 @@ -4844,16 +4844,16 @@ packages: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} dev: true - /typedoc-plugin-missing-exports@1.0.0(typedoc@0.23.28): + /typedoc-plugin-missing-exports@1.0.0(typedoc@0.24.1): resolution: {integrity: sha512-7s6znXnuAj1eD9KYPyzVzR1lBF5nwAY8IKccP5sdoO9crG4lpd16RoFpLsh2PccJM+I2NASpr0+/NMka6ThwVA==} peerDependencies: typedoc: 0.22.x || 0.23.x dependencies: - typedoc: 0.23.28(typescript@4.9.5) + typedoc: 0.24.1(typescript@4.9.5) dev: true - /typedoc@0.23.28(typescript@4.9.5): - resolution: {integrity: sha512-9x1+hZWTHEQcGoP7qFmlo4unUoVJLB0H/8vfO/7wqTnZxg4kPuji9y3uRzEu0ZKez63OJAUmiGhUrtukC6Uj3w==} + /typedoc@0.24.1(typescript@4.9.5): + resolution: {integrity: sha512-u4HwjZcSQhQSkkhLjgcs0ooAf6HrFVLDHHrwU2xZW8WxH0KnGZlNkaWxiOcK5Gagj7mxJSgwWx0dv8ACDAOXAQ==} engines: {node: '>= 14.14'} hasBin: true peerDependencies: @@ -5013,12 +5013,12 @@ packages: fsevents: 2.3.2 dev: true - /vitepress@1.0.0-alpha.64(@algolia/client-search@4.17.0)(@types/node@18.15.11)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0): - resolution: {integrity: sha512-u12wcDH4VzgxxkQfVQWkXumrL3WRetpenz4VuAtiMWXeZSCayWcJtieWOFxmX/RzS2KEuTJpXGbtJAXORyyJBQ==} + /vitepress@1.0.0-alpha.65(@algolia/client-search@4.17.0)(@types/node@18.15.11)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0): + resolution: {integrity: sha512-iGWC0AQC6WrfRZTJf5+TiGG4o8PLhqIJNyai8NVxZCY9YpmMJhddvQeqqjJdQniF/LQK/hQ5nQZ9HgSZDGRPGQ==} hasBin: true dependencies: '@docsearch/css': 3.3.3 - '@docsearch/js': 3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.32)(react-dom@18.2.0)(react@18.2.0) + '@docsearch/js': 3.3.3(@algolia/client-search@4.17.0)(@types/react@18.0.35)(react-dom@18.2.0)(react@18.2.0) '@vitejs/plugin-vue': 4.1.0(vite@4.2.1)(vue@3.2.47) '@vue/devtools-api': 6.5.0 '@vueuse/core': 9.13.0(vue@3.2.47) diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts index ba1e4367..c4fcd983 100644 --- a/scripts/apidoc/apiDocsWriter.ts +++ b/scripts/apidoc/apiDocsWriter.ts @@ -1,6 +1,7 @@ import { writeFileSync } from 'node:fs'; import { resolve } from 'node:path'; import type { ProjectReflection } from 'typedoc'; +import { ReflectionKind } from 'typedoc'; import type { Method } from '../../docs/.vitepress/components/api-docs/method'; import type { APIGroup } from '../../docs/api/api-types'; import { formatMarkdown, formatTypescript } from './format'; @@ -216,7 +217,9 @@ export function writeApiSearchIndex(pages: ModuleSummary[]): void { * @param project The typedoc project. */ export function writeSourceBaseUrl(project: ProjectReflection): void { - const baseUrl = extractSourceBaseUrl(project); + const baseUrl = extractSourceBaseUrl( + project.getChildrenByKind(ReflectionKind.Class)[0] + ); let content = ` // This file is automatically generated. diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts index 05944ba7..3d8fd6f7 100644 --- a/scripts/apidoc/signature.ts +++ b/scripts/apidoc/signature.ts @@ -20,11 +20,11 @@ import vitepressConfig from '../../docs/.vitepress/config'; import { formatTypescript } from './format'; import { extractDeprecated, + extractRawDefault, extractRawExamples, extractSeeAlsos, extractSince, extractSourcePath, - joinTagContent, joinTagParts, } from './typedoc'; import { pathOutputDir } from './utils'; @@ -382,7 +382,7 @@ function extractDefaultFromComment(comment?: Comment): string | undefined { const defaultTag = comment.getTag('@default'); if (defaultTag) { - return joinTagContent(defaultTag).join().trim(); + return extractRawDefault({ comment }); } const summary = comment.summary; diff --git a/scripts/apidoc/typedoc.ts b/scripts/apidoc/typedoc.ts index 0b19c1b4..7fc1450b 100644 --- a/scripts/apidoc/typedoc.ts +++ b/scripts/apidoc/typedoc.ts @@ -21,6 +21,8 @@ import { } from './parameterDefaults'; import { mapByName } from './utils'; +type CommentHolder = Pick; + /** * Loads the project using TypeDoc. * @@ -152,7 +154,9 @@ export function extractModuleFieldName(module: DeclarationReflection): string { * * @param reflection The reflection instance to extract the source url from. */ -function extractSourceUrl(reflection: Reflection): string { +function extractSourceUrl( + reflection: DeclarationReflection | SignatureReflection +): string { const source = reflection.sources?.[0]; return source?.url ?? ''; } @@ -162,7 +166,9 @@ function extractSourceUrl(reflection: Reflection): string { * * @param reflection The reflection instance to extract the source base url from. */ -export function extractSourceBaseUrl(reflection: Reflection): string { +export function extractSourceBaseUrl( + reflection: DeclarationReflection | SignatureReflection +): string { return extractSourceUrl(reflection).replace( /^(.*\/blob\/[0-9a-f]+\/)(.*)$/, '$1' @@ -174,7 +180,9 @@ export function extractSourceBaseUrl(reflection: Reflection): string { * * @param reflection The reflection instance to extract the source path from. */ -export function extractSourcePath(reflection: Reflection): string { +export function extractSourcePath( + reflection: DeclarationReflection | SignatureReflection +): string { return extractSourceUrl(reflection).replace( /^(.*\/blob\/[0-9a-f]+\/)(.*)$/, '$2' @@ -189,29 +197,51 @@ export function extractSourcePath(reflection: Reflection): string { */ export function extractTagContent( tag: `@${string}`, - reflection?: Reflection, + reflection?: CommentHolder, tagProcessor: (tag: CommentTag) => string[] = joinTagContent ): string[] { return reflection?.comment?.getTags(tag).flatMap(tagProcessor) ?? []; } /** - * Extracts the examples from the jsdocs without the surrounding md code block. + * Extracts the raw code from the jsdocs without the surrounding md code block. * - * @param reflection The reflection to extract the examples from. + * @param tag The tag to extract the code from. + * @param reflection The reflection to extract the code from. */ -export function extractRawExamples(reflection?: Reflection): string[] { - return extractTagContent('@example', reflection).map((tag) => +function extractRawCode( + tag: `@${string}`, + reflection?: CommentHolder +): string[] { + return extractTagContent(tag, reflection).map((tag) => tag.replace(/^```ts\n/, '').replace(/\n```$/, '') ); } +/** + * Extracts the default from the jsdocs without the surrounding md code block. + * + * @param reflection The reflection to extract the examples from. + */ +export function extractRawDefault(reflection?: CommentHolder): string { + return extractRawCode('@default', reflection)[0] ?? ''; +} + +/** + * Extracts the examples from the jsdocs without the surrounding md code block. + * + * @param reflection The reflection to extract the examples from. + */ +export function extractRawExamples(reflection?: CommentHolder): string[] { + return extractRawCode('@example', reflection); +} + /** * Extracts all the `@see` references from the jsdocs separately. * * @param reflection The reflection to extract the see also references from. */ -export function extractSeeAlsos(reflection?: Reflection): string[] { +export function extractSeeAlsos(reflection?: CommentHolder): string[] { return extractTagContent('@see', reflection, (tag) => // If the @see tag contains code in backticks, the content is split into multiple parts. // So we join together, split on newlines and filter out empty tags. @@ -249,7 +279,9 @@ export function joinTagParts(parts?: CommentDisplayPart[]): string | undefined { * * @returns The message explaining the deprecation if deprecated, otherwise `undefined`. */ -export function extractDeprecated(reflection?: Reflection): string | undefined { +export function extractDeprecated( + reflection?: CommentHolder +): string | undefined { const deprecated = extractTagContent('@deprecated', reflection).join().trim(); return deprecated.length === 0 ? undefined : deprecated; } @@ -261,6 +293,6 @@ export function extractDeprecated(reflection?: Reflection): string | undefined { * * @returns The contents of the `@since` tag. */ -export function extractSince(reflection: Reflection): string { +export function extractSince(reflection: CommentHolder): string { return extractTagContent('@since', reflection).join().trim(); } diff --git a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap index 715c85aa..fe12e025 100644 --- a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap +++ b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap @@ -8,8 +8,7 @@ exports[`signature > analyzeSignature() > complexArrayParameter 1`] = ` "examples": "
ts
complexArrayParameter<T>(array: readonly Array<{
   value: T,
   weight: number
-}>): T
-
+}>): T
", "name": "complexArrayParameter", "parameters": [ @@ -53,8 +52,7 @@ exports[`signature > analyzeSignature() > defaultBooleanParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with a default parameter.

", - "examples": "
ts
defaultBooleanParamMethod(c: boolean = true): number
-
+ "examples": "
ts
defaultBooleanParamMethod(c: boolean = true): number
", "name": "defaultBooleanParamMethod", "parameters": [ @@ -102,8 +100,7 @@ exports[`signature > analyzeSignature() > functionParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with a function parameters.

", - "examples": "
ts
functionParamMethod(fn: (a: string) => number): number
-
+ "examples": "
ts
functionParamMethod(fn: (a: string) => number): number
", "name": "functionParamMethod", "parameters": [ @@ -127,8 +124,7 @@ exports[`signature > analyzeSignature() > literalUnionParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with LiteralUnion.

", - "examples": "
ts
literalUnionParamMethod(value: 'a' | 'b' | string, namedValue: 'a' | 'b' | string, array: readonly Array<'a' | 'b' | string>, namedArray: readonly Array<'a' | 'b' | string>, mixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>, namedMixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>): string
-
+ "examples": "
ts
literalUnionParamMethod(value: 'a' | 'b' | string, namedValue: 'a' | 'b' | string, array: readonly Array<'a' | 'b' | string>, namedArray: readonly Array<'a' | 'b' | string>, mixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>, namedMixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>): string
", "name": "literalUnionParamMethod", "parameters": [ @@ -188,8 +184,7 @@ exports[`signature > analyzeSignature() > methodWithDeprecated 1`] = ` ", "description": "

Test with deprecated and see marker.

", - "examples": "
ts
methodWithDeprecated(): number
-
+ "examples": "
ts
methodWithDeprecated(): number
", "name": "methodWithDeprecated", "parameters": [], @@ -211,8 +206,7 @@ exports[`signature > analyzeSignature() > methodWithDeprecatedOption 1`] = ` a: string, b: () => number, c: number -}): number - +}): number
", "name": "methodWithDeprecatedOption", "parameters": [ @@ -260,8 +254,7 @@ exports[`signature > analyzeSignature() > methodWithExample 1`] = ` "description": "

Test with example marker.

", "examples": "
ts
methodWithExample(): number
-test.apidoc.methodWithExample() // 0
-
+test.apidoc.methodWithExample() // 0
", "name": "methodWithExample", "parameters": [], @@ -277,8 +270,7 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkers 1`] = ` "deprecated": undefined, "description": "

Test with multiple see markers.

", - "examples": "
ts
methodWithMultipleSeeMarkers(): number
-
+ "examples": "
ts
methodWithMultipleSeeMarkers(): number
", "name": "methodWithMultipleSeeMarkers", "parameters": [], @@ -297,8 +289,7 @@ exports[`signature > analyzeSignature() > methodWithMultipleSeeMarkersAndBacktic "deprecated": undefined, "description": "

Test with multiple see markers and backticks.

", - "examples": "
ts
methodWithMultipleSeeMarkersAndBackticks(): number
-
+ "examples": "
ts
methodWithMultipleSeeMarkersAndBackticks(): number
", "name": "methodWithMultipleSeeMarkersAndBackticks", "parameters": [], @@ -317,8 +308,7 @@ exports[`signature > analyzeSignature() > methodWithSinceMarker 1`] = ` "deprecated": undefined, "description": "

Test with since marker.

", - "examples": "
ts
methodWithSinceMarker(): number
-
+ "examples": "
ts
methodWithSinceMarker(): number
", "name": "methodWithSinceMarker", "parameters": [], @@ -334,8 +324,7 @@ exports[`signature > analyzeSignature() > multiParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with multiple parameters.

", - "examples": "
ts
multiParamMethod(a: number, b?: string, c: boolean = true): number
-
+ "examples": "
ts
multiParamMethod(a: number, b?: string, c: boolean = true): number
", "name": "multiParamMethod", "parameters": [ @@ -373,8 +362,7 @@ exports[`signature > analyzeSignature() > noParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with no parameters.

", - "examples": "
ts
noParamMethod(): number
-
+ "examples": "
ts
noParamMethod(): number
", "name": "noParamMethod", "parameters": [], @@ -390,8 +378,7 @@ exports[`signature > analyzeSignature() > optionalStringParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with an optional parameter.

", - "examples": "
ts
optionalStringParamMethod(b?: string): number
-
+ "examples": "
ts
optionalStringParamMethod(b?: string): number
", "name": "optionalStringParamMethod", "parameters": [ @@ -421,8 +408,7 @@ exports[`signature > analyzeSignature() > optionsInlineParamMethodWithDefaults 1 value: number } = { value: 1 }, c: { value: number -}): number - +}): number
", "name": "optionsInlineParamMethodWithDefaults", "parameters": [ @@ -483,8 +469,7 @@ exports[`signature > analyzeSignature() > optionsInterfaceParamMethodWithDefault "deprecated": undefined, "description": "

Test with a function parameters with defaults.

", - "examples": "
ts
optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number
-
+ "examples": "
ts
optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number
", "name": "optionsInterfaceParamMethodWithDefaults", "parameters": [ @@ -528,8 +513,7 @@ exports[`signature > analyzeSignature() > optionsParamMethod 1`] = ` c: boolean, d: () => string, e: 'a' | 'b' | string -}): number - +}): number
", "name": "optionsParamMethod", "parameters": [ @@ -588,8 +572,7 @@ exports[`signature > analyzeSignature() > optionsTypeParamMethodWithDefaults 1`] "deprecated": undefined, "description": "

Test with a function parameters with defaults.

", - "examples": "
ts
optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number
-
+ "examples": "
ts
optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number
", "name": "optionsTypeParamMethodWithDefaults", "parameters": [ @@ -627,8 +610,7 @@ exports[`signature > analyzeSignature() > requiredNumberParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with a required parameter.

", - "examples": "
ts
requiredNumberParamMethod(a: number): number
-
+ "examples": "
ts
requiredNumberParamMethod(a: number): number
", "name": "requiredNumberParamMethod", "parameters": [ @@ -653,11 +635,10 @@ exports[`signature > analyzeSignature() > stringUnionParamMethod 1`] = ` "description": "

Test with string union.

", "examples": "
ts
stringUnionParamMethod(value: 'a' | 'b', options?: {
-  casing: 'lower' | 'mixed' | 'upper',
+  casing: Casing,
   excludes: readonly AlphaNumericChar[],
-  format: 'binary' | 'css' | 'decimal' | 'hex'
-}): string
-
+ format: 'hex' | ColorFormat +}): string
", "name": "stringUnionParamMethod", "parameters": [ @@ -680,7 +661,7 @@ exports[`signature > analyzeSignature() > stringUnionParamMethod 1`] = ` "description": "

The casing parameter.

", "name": "options.casing?", - "type": "'lower' | 'mixed' | 'upper'", + "type": "Casing", }, { "default": undefined, @@ -694,7 +675,7 @@ exports[`signature > analyzeSignature() > stringUnionParamMethod 1`] = ` "description": "

The format parameter.

", "name": "options.format?", - "type": "'binary' | 'css' | 'decimal' | 'hex'", + "type": "'hex' | ColorFormat", }, ], "returns": "string", -- cgit v1.2.3