Skip to content

fix: properly handle promise generics #258

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

fix: properly handle promise generics #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
447428b
fix: properly handle promise generics
hansemannn Aug 19, 2025
2afeb59
fix: do not throw error regarding generic promises
hansemannn Aug 19, 2025
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
19 changes: 17 additions & 2 deletions packages/titanium-docgen/generators/typescript_generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,9 @@ class DocsParser {
// skip bundled documentation for modules and Node.js shims
return;
}
const namespaceParts = typeInfo.name.split('.');
// Handle generic types by extracting the base type name before the first '<'
const typeName = typeInfo.name.split('<')[0];
const namespaceParts = typeName.split('.');
namespaceParts.pop();
if (skipApis.includes(typeInfo.name)) {
return;
Expand Down Expand Up @@ -622,7 +624,17 @@ class GlobalTemplateWriter {

if (Array.isArray(docType)) {
const normalizedTypes = docType.map(typeName => this.normalizeType(typeName));
return normalizedTypes.includes('any') ? 'any' : normalizedTypes.join(' | ');
if (normalizedTypes.includes('any')) {
return 'any';
}
// Parenthesize function types in unions to avoid TypeScript syntax errors
const parenthesizedTypes = normalizedTypes.map(type => {
if (type.includes(') => ')) {
return `(${type})`;
}
return type;
});
return parenthesizedTypes.join(' | ');
}

const lessThanIndex = docType.indexOf('<');
Expand All @@ -649,6 +661,9 @@ class GlobalTemplateWriter {
}
} else if (baseType === 'Dictionary') {
return `Dictionary<${subType}>`;
} else if (baseType === 'Promise') {
// Use standard Promise<T> generic syntax
return `Promise<${subTypes.join(', ')}>`;
}
}

Expand Down
8 changes: 6 additions & 2 deletions packages/titanium-docgen/validate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,8 +434,12 @@ function validateDataType(type, fullTypeContext) {
// Should it have been written as a complex type?
if (common.COMPLEX_TYPES.has(type)) {
const argCount = common.COMPLEX_TYPES.get(type); // may be 0 if Function/Callback
// Enforce as ERROR if Promise/Set/Map doesn't have exact generic type count
const severity = [ 'Map', 'Set', 'Promise' ].includes(type) ? ERROR : WARNING;
// Skip validation for Promise to allow Promise without generics (Promise<T> not supported by build system)
if (type === 'Promise') {
return errors;
}
// Enforce as ERROR if Set/Map doesn't have exact generic type count
const severity = [ 'Map', 'Set' ].includes(type) ? ERROR : WARNING;
errors.push(new Problem(`${type} ${severity === ERROR ? 'must' : 'should'} have ${argCount || 'any number of'} generic type(s) specified, but had 0: ${fullTypeContext || type}`, severity));
} else if (type === 'Object') {
// Warn about generic Object types (Dictionary is handled above as a complex type)
Expand Down