Skip to content

fix: Support for type operators readonly & `unique #1356

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

Merged
merged 2 commits into from
Aug 28, 2020
Merged

fix: Support for type operators readonly & `unique #1356

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
da5c774
fix: Support for type operators `readonly` & `unique`
ericzhangjx Aug 25, 2020
6a1af37
chore: add & rebuild tests for type operators
ericzhangjx Aug 25, 2020
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
14 changes: 13 additions & 1 deletion src/lib/converter/types/type-operator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ export class TypeOperatorConverter extends ConverterTypeComponent implements Typ
*/
priority = 50;

/**
* add two more operators based on the references below:
* https://github.com/microsoft/TypeScript/blob/e83102134e5640abb78b0c62941b3b5003ab6c1a/src/compiler/types.ts#L1602
* https://github.com/TypeStrong/typedoc/blob/b7a5b2d5ea1ae088e9510783ede20e842b120d0f/src/lib/converter/types.ts#L375
*/
private readonly supportedOperatorNames = {
[ts.SyntaxKind.KeyOfKeyword]: 'keyof',
[ts.SyntaxKind.UniqueKeyword]: 'unique',
[ts.SyntaxKind.ReadonlyKeyword]: 'readonly'
} as const;

/**
* Test whether this converter can handle the given TypeScript node.
*/
Expand All @@ -28,7 +39,8 @@ export class TypeOperatorConverter extends ConverterTypeComponent implements Typ
convertNode(context: Context, node: ts.TypeOperatorNode): TypeOperatorType | undefined {
const target = this.owner.convertType(context, node.type);
if (target) {
return new TypeOperatorType(target);
const operator = this.supportedOperatorNames[node.operator];
return new TypeOperatorType(target, operator);
}
}
}
13 changes: 3 additions & 10 deletions src/lib/models/types/type-operator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,8 @@ export class TypeOperatorType extends Type {
*/
readonly type = 'typeOperator';

target: Type;

// currently, there is only one type operator, this is always "keyof"
// but, if more types will be added in the future we are ready.
readonly operator = 'keyof';

constructor(target: Type) {
constructor(public target: Type, public operator: 'keyof' | 'unique' | 'readonly') {
super();
this.target = target;
}

/**
Expand All @@ -31,7 +24,7 @@ export class TypeOperatorType extends Type {
* @return A clone of this type.
*/
clone(): Type {
return new TypeOperatorType(this.target.clone());
return new TypeOperatorType(this.target.clone(), this.operator);
}

/**
Expand All @@ -45,7 +38,7 @@ export class TypeOperatorType extends Type {
return false;
}

return type.target.equals(this.target);
return type instanceof TypeOperatorType && type.operator === this.operator && type.target.equals(this.target);
}

/**
Expand Down
193 changes: 170 additions & 23 deletions src/test/converter/types/specs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,152 @@
},
{
"id": 4,
"name": "\"type-operator\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "%BASE%/types/type-operator.ts",
"children": [
{
"id": 6,
"name": "B",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"type": {
"type": "typeOperator",
"operator": "readonly",
"target": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
}
},
{
"id": 7,
"name": "C",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 8,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 9,
"name": "prop1",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 10,
"name": "prop2",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
9,
10
]
}
]
}
}
},
{
"id": 11,
"name": "D",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "reference",
"id": 7,
"name": "C"
}
}
},
{
"id": 5,
"name": "a",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"type": {
"type": "typeOperator",
"operator": "unique",
"target": {
"type": "intrinsic",
"name": "symbol"
}
},
"defaultValue": "Symbol()"
}
],
"groups": [
{
"title": "Type aliases",
"kind": 4194304,
"children": [
6,
7,
11
]
},
{
"title": "Variables",
"kind": 32,
"children": [
5
]
}
]
},
{
"id": 12,
"name": "\"union-or-intersection\"",
"kind": 1,
"kindString": "Module",
Expand All @@ -75,7 +221,7 @@
"originalName": "%BASE%/types/union-or-intersection.ts",
"children": [
{
"id": 5,
"id": 13,
"name": "FirstType",
"kind": 256,
"kindString": "Interface",
Expand All @@ -87,7 +233,7 @@
},
"children": [
{
"id": 6,
"id": 14,
"name": "firstProperty",
"kind": 1024,
"kindString": "Property",
Expand All @@ -108,13 +254,13 @@
"title": "Properties",
"kind": 1024,
"children": [
6
14
]
}
]
},
{
"id": 7,
"id": 15,
"name": "SecondType",
"kind": 256,
"kindString": "Interface",
Expand All @@ -126,7 +272,7 @@
},
"children": [
{
"id": 8,
"id": 16,
"name": "secondProperty",
"kind": 1024,
"kindString": "Property",
Expand All @@ -147,13 +293,13 @@
"title": "Properties",
"kind": 1024,
"children": [
8
16
]
}
]
},
{
"id": 9,
"id": 17,
"name": "ThirdType",
"kind": 256,
"kindString": "Interface",
Expand All @@ -165,7 +311,7 @@
},
"children": [
{
"id": 12,
"id": 20,
"name": "thirdComplexProperty",
"kind": 1024,
"kindString": "Property",
Expand All @@ -191,12 +337,12 @@
"types": [
{
"type": "reference",
"id": 5,
"id": 13,
"name": "FirstType"
},
{
"type": "reference",
"id": 7,
"id": 15,
"name": "SecondType"
}
]
Expand All @@ -207,7 +353,7 @@
}
},
{
"id": 11,
"id": 19,
"name": "thirdIntersectionProperty",
"kind": 1024,
"kindString": "Property",
Expand All @@ -222,19 +368,19 @@
"types": [
{
"type": "reference",
"id": 5,
"id": 13,
"name": "FirstType"
},
{
"type": "reference",
"id": 9,
"id": 17,
"name": "ThirdType"
}
]
}
},
{
"id": 10,
"id": 18,
"name": "thirdUnionProperty",
"kind": 1024,
"kindString": "Property",
Expand All @@ -249,12 +395,12 @@
"types": [
{
"type": "reference",
"id": 5,
"id": 13,
"name": "FirstType"
},
{
"type": "reference",
"id": 7,
"id": 15,
"name": "SecondType"
}
]
Expand All @@ -266,9 +412,9 @@
"title": "Properties",
"kind": 1024,
"children": [
12,
11,
10
20,
19,
18
]
}
]
Expand All @@ -279,9 +425,9 @@
"title": "Interfaces",
"kind": 256,
"children": [
5,
7,
9
13,
15,
17
]
}
]
Expand All @@ -293,7 +439,8 @@
"kind": 1,
"children": [
1,
4
4,
12
]
}
]
Expand Down
7 changes: 7 additions & 0 deletions src/test/converter/types/type-operator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export const a: unique symbol = Symbol();
export type B = readonly number[];
export type C = {
prop1: string;
prop2: number;
};
export type D = keyof C;