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

fix: prefix promise types where appropriate #234

Merged
merged 2 commits into from
Jun 12, 2023
Merged

fix: prefix promise types where appropriate #234

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fa5086
Revert "fix: do not prefix promise inner types (#227)"
MarshallOfSound Jun 12, 2023
d348855
fix: prefix promise types where appropriate
MarshallOfSound Jun 12, 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
15 changes: 14 additions & 1 deletion src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,19 @@ export const wrapComment = (comment: string, additionalTags: DocumentationTag[]
return result.concat(' */');
};

const prefixTypeForSafety = (type: string) => {
if (
type !== 'Object' &&
typeof type === 'string' &&
!isPrimitive(type) &&
!isBuiltIn(type) &&
!/\(\| /gi.test(type)
) {
return `Electron.${type}`;
}
return type;
};

export const typify = (
type: TypeInformation | TypeInformation[],
maybeInnerReturnTypeName?: string,
Expand Down Expand Up @@ -211,7 +224,7 @@ export const typify = (
return '(() => void)';
case 'promise':
if (innerTypes) {
return `Promise<${typify(innerTypes[0])}>`;
return `Promise<${prefixTypeForSafety(typify(innerTypes[0]))}>`;
}
throw new Error('Promise with missing inner type');
case 'record':
Expand Down