Skip to content

Commit 97fdf69

Browse files
authored
fix(metadata): add missing void and iterable types to builtin map (#848)
1 parent edbfd09 commit 97fdf69

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

src/generators/metadata/maps/builtin.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
22
"asynciterable": "https://tc39.github.io/ecma262/#sec-asynciterable-interface",
3+
"iterable": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol",
4+
"void": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/void",
35
"module namespace object": "https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects",
46
"null": "https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#null_type",
57
"undefined": "https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#undefined_type",

src/generators/metadata/utils/__tests__/transformers.test.mjs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,13 @@ describe('transformTypeToReferenceLink', () => {
5555
);
5656
});
5757

58-
it('should handle outer unions with generics like {Promise<string|number> | boolean}', () => {
58+
it('should handle outer unions with generics like {Promise<string|number> | Iterable<boolean>}', () => {
5959
strictEqual(
60-
transformTypeToReferenceLink('{Promise<string|number> | boolean}', {}),
61-
'[`<Promise>`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[`<string>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type) | [`<number>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type)&gt; | [`<boolean>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type)'
60+
transformTypeToReferenceLink(
61+
'{Promise<string|number> | Iterable<boolean>}',
62+
{}
63+
),
64+
'[`<Promise>`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[`<string>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type) | [`<number>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type)&gt; | [`<Iterable>`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol)&lt;[`<boolean>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type)&gt;'
6265
);
6366
});
6467

@@ -105,7 +108,7 @@ describe('transformTypeToReferenceLink', () => {
105108
'(cb: ([first, second]: string[]) => void) => ({ id, name }: User) => boolean';
106109

107110
const expected =
108-
'(cb: ([first, second]: [`<string>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type)[]) =&gt; `<void>`) =&gt; ({ id, name }: [`<User>`](userLink)) =&gt; [`<boolean>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type)';
111+
'(cb: ([first, second]: [`<string>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type)[]) =&gt; [`<void>`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/void)) =&gt; ({ id, name }: [`<User>`](userLink)) =&gt; [`<boolean>`](https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type)';
109112

110113
strictEqual(
111114
transformTypeToReferenceLink(input, { User: 'userLink' }),

0 commit comments

Comments
 (0)