Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: correct typo in GenerateTypesOptions #81

Merged
merged 2 commits into from
Mar 27, 2023
Merged

fix: correct typo in GenerateTypesOptions #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ff5f5b
fix: correct typo in `GenerateTypesOptions`
danielroe Mar 27, 2023
4fcb045
chore: add comment
danielroe Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/generator/dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export interface GenerateTypesOptions {
interfaceName?: string;
addExport?: boolean;
addDefaults?: boolean;
defaultDescrption?: string;
defaultDescription?: string;
indentation?: number;
allowExtraKeys?: boolean;
partial?: boolean;
Expand Down Expand Up @@ -214,6 +214,10 @@ export function genFunctionArgs(
}

function generateJSDoc(schema: Schema, opts: GenerateTypesOptions): string[] {
// TODO: remove when appropriate
// @ts-expect-error - legacy typo
opts.defaultDescription = opts.defaultDescription || opts.defaultDescrption;

let buff = [];

if (schema.title) {
Expand All @@ -222,8 +226,8 @@ function generateJSDoc(schema: Schema, opts: GenerateTypesOptions): string[] {

if (schema.description) {
buff.push(schema.description, "");
} else if (opts.defaultDescrption && schema.type !== "object") {
buff.push(opts.defaultDescrption, "");
} else if (opts.defaultDescription && schema.type !== "object") {
buff.push(opts.defaultDescription, "");
}

if (
Expand Down