Add a test case for TypeScript 3.7 getters/setters

Author: octogonz

build-tests/api-documenter-test/etc/api-documenter-test.api.json

@@ -353,6 +353,32 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "api-documenter-test!DocClass1#readonlyProperty:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get readonlyProperty(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "readonlyProperty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "api-documenter-test!DocClass1#regularProperty:member",
@@ -466,6 +492,36 @@
               "overloadIndex": 1,
               "parameters": [],
               "name": "tableExample"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "api-documenter-test!DocClass1#writeableProperty:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get writeableProperty(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                },
+                {
+                  "kind": "Content",
+                  "text": "\n\nset writeableProperty(value: string);"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "writeableProperty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
             }
           ],
           "extendsTokenRange": {

build-tests/api-documenter-test/etc/api-documenter-test.api.md

@@ -26,9 +26,14 @@ export class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInter
     malformedEvent: SystemEvent;
     // @eventProperty
     readonly modifiedEvent: SystemEvent;
+    // (undocumented)
+    get readonlyProperty(): string;
     regularProperty: SystemEvent;
     static sumWithExample(x: number, y: number): number;
     tableExample(): void;
+    // (undocumented)
+    get writeableProperty(): string;
+    set writeableProperty(value: string);
 }
 
 // @public

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md

@@ -29,7 +29,9 @@ The constructor for this class is marked as internal. Third-party code should no
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) |  | <code>string</code> |  |
 |  [regularProperty](./api-documenter-test.docclass1.regularproperty.md) |  | <code>SystemEvent</code> | This is a regular property that happens to use the SystemEvent type. |
+|  [writeableProperty](./api-documenter-test.docclass1.writeableproperty.md) |  | <code>string</code> |  |
 
 ## Methods
 

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.readonlyproperty.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md)
+
+## DocClass1.readonlyProperty property
+
+<b>Signature:</b>
+
+```typescript
+get readonlyProperty(): string;
+```

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeableproperty.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [writeableProperty](./api-documenter-test.docclass1.writeableproperty.md)
+
+## DocClass1.writeableProperty property
+
+<b>Signature:</b>
+
+```typescript
+get writeableProperty(): string;
+
+set writeableProperty(value: string);
+```

build-tests/api-documenter-test/etc/yaml/api-documenter-test/docclass1.yml

@@ -28,9 +28,11 @@ items:
       - 'api-documenter-test!DocClass1#interestingEdgeCases:member(1)'
       - 'api-documenter-test!DocClass1#malformedEvent:member'
       - 'api-documenter-test!DocClass1#modifiedEvent:member'
+      - 'api-documenter-test!DocClass1#readonlyProperty:member'
       - 'api-documenter-test!DocClass1#regularProperty:member'
       - 'api-documenter-test!DocClass1.sumWithExample:member(1)'
       - 'api-documenter-test!DocClass1#tableExample:member(1)'
+      - 'api-documenter-test!DocClass1#writeableProperty:member'
   - uid: 'api-documenter-test!DocClass1#deprecatedExample:member(1)'
     deprecated:
       content: Use `otherThing()` instead.
@@ -125,6 +127,17 @@ items:
       return:
         type:
           - 'api-documenter-test!SystemEvent:class'
+  - uid: 'api-documenter-test!DocClass1#readonlyProperty:member'
+    name: readonlyProperty
+    fullName: readonlyProperty
+    langs:
+      - typeScript
+    type: property
+    syntax:
+      content: 'get readonlyProperty(): string;'
+      return:
+        type:
+          - string
   - uid: 'api-documenter-test!DocClass1#regularProperty:member'
     summary: This is a regular property that happens to use the SystemEvent type.
     name: regularProperty
@@ -174,6 +187,20 @@ items:
         type:
           - void
         description: ''
+  - uid: 'api-documenter-test!DocClass1#writeableProperty:member'
+    name: writeableProperty
+    fullName: writeableProperty
+    langs:
+      - typeScript
+    type: property
+    syntax:
+      content: |-
+        get writeableProperty(): string;
+
+        set writeableProperty(value: string);
+      return:
+        type:
+          - string
 references:
   - uid: 'api-documenter-test!DocBaseClass:class'
     name: DocBaseClass

build-tests/api-documenter-test/src/DocClass1.ts

@@ -176,6 +176,16 @@ export class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInter
     return x;
   }
 
+  public get readonlyProperty(): string {
+    return 'hello';
+  }
+
+  public get writeableProperty(): string {
+    return 'hello';
+  }
+  public set writeableProperty(value: string) {
+  }
+
   /**
    * This event is fired whenever the object is modified.
    * @eventProperty

build-tests/api-extractor-lib1-test/etc/api-extractor-lib1-test.api.md

@@ -8,6 +8,10 @@
 //
 // @public (undocumented)
 export class Lib1Class extends Lib1ForgottenExport {
+    // (undocumented)
+    readonly readonlyProperty: string;
+    // (undocumented)
+    writeableProperty: string;
 }
 
 // @alpha (undocumented)

build-tests/api-extractor-lib1-test/src/index.ts

@@ -14,6 +14,15 @@ import { Lib1ForgottenExport } from './Lib1ForgottenExport';
 
 /** @public */
 export class Lib1Class extends Lib1ForgottenExport {
+  public get readonlyProperty(): string {
+    return 'hello';
+  }
+
+  public get writeableProperty(): string {
+    return 'hello';
+  }
+  public set writeableProperty(value: string) {
+  }
 }
 
 /** @alpha */

build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json

@@ -450,6 +450,62 @@
               "overloadIndex": 1,
               "parameters": [],
               "name": "member"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "api-extractor-scenarios!SimpleClass#readonlyProperty:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get readonlyProperty(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "readonlyProperty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "api-extractor-scenarios!SimpleClass#writeableProperty:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get writeableProperty(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                },
+                {
+                  "kind": "Content",
+                  "text": "\n\nset writeableProperty(value: string);"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "writeableProperty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
             }
           ],
           "implementsTokenRanges": []

build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.md

@@ -57,6 +57,11 @@ export enum RegularEnum {
 export class SimpleClass {
     // (undocumented)
     member(): void;
+    // (undocumented)
+    get readonlyProperty(): string;
+    // (undocumented)
+    get writeableProperty(): string;
+    set writeableProperty(value: string);
 }
 
 // @public (undocumented)

build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/rollup.d.ts

@@ -55,6 +55,9 @@ export declare enum RegularEnum {
 /** @public */
 export declare class SimpleClass {
     member(): void;
+    get readonlyProperty(): string;
+    get writeableProperty(): string;
+    set writeableProperty(value: string);
 }
 
 /** @public */

build-tests/api-extractor-scenarios/etc/test-outputs/bundledPackages/rollup.d.ts

@@ -5,6 +5,8 @@ export declare function f(arg1: Lib1Class, arg2: Lib2Class): void;
 
 /** @public */
 declare class Lib1Class extends Lib1ForgottenExport {
+    readonly readonlyProperty: string;
+    writeableProperty: string;
 }
 
 declare class Lib1ForgottenExport {

build-tests/api-extractor-scenarios/src/apiItemKinds/classes.ts

@@ -11,4 +11,14 @@ export abstract class AbstractClass {
 export class SimpleClass {
   public member(): void {
   }
+
+  public get readonlyProperty(): string {
+    return 'hello';
+  }
+
+  public get writeableProperty(): string {
+    return 'hello';
+  }
+  public set writeableProperty(value: string) {
+  }
 }