{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.28.3", "schemaVersion": 1009, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "simple-suite-test!", "docComment": "/**\n * Test package\n *\n * @remarks\n *\n * This remarks block includes a bulleted list!\n *\n * - Bullet 1\n *\n * - Bullet 2\n *\n * And an ordered list for good measure!\n *\n * 1. List item 1\n *\n * 2. List item 2\n *\n * 3. List item 3\n *\n * Also, here is a link test, including a bad link, because we should have some reasonable support if this happens:\n *\n * - Good link (no alias): {@link TestClass}\n *\n * - Good link (with alias): {@link testFunction | function alias text}\n *\n * - Bad link (no alias): {@link InvalidItem}\n *\n * - Bad link (with alias): {@link InvalidItem | even though I link to an invalid item, I would still like this text to be rendered}\n *\n * @example\n *\n * A test example\n * ```typescript\n * const foo = bar;\n * ```\n *\n * @packageDocumentation\n */\n", "name": "simple-suite-test", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "simple-suite-test!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "simple-suite-test!TestClass:class", "docComment": "/**\n * Test class\n *\n * @remarks\n *\n * Here are some remarks about the class\n *\n * @typeParam TTypeParameterA - A type parameter\n *\n * @typeParam TTypeParameterB - Another type parameter\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class TestClass " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TTypeParameterA", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TTypeParameterB", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "TestClass", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "simple-suite-test!TestClass:constructor(1)", "docComment": "/**\n * Test class constructor\n *\n * @remarks\n *\n * Here are some remarks about the constructor\n *\n * @param testClassProperty - See {@link TestClass.testClassProperty}\n *\n * @param testClassEventProperty - See {@link TestClass.testClassEventProperty}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(testClassProperty: " }, { "kind": "Content", "text": "TTypeParameterB" }, { "kind": "Content", "text": ", testClassEventProperty: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "testClassProperty", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "testClassEventProperty", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "simple-suite-test!TestClass#testClassEventProperty:member", "docComment": "/**\n * Test class event property\n *\n * @remarks\n *\n * Here are some remarks about the property\n *\n * @eventProperty\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly testClassEventProperty: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "testClassEventProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false }, { "kind": "Property", "canonicalReference": "simple-suite-test!TestClass#testClassGetterProperty:member", "docComment": "/**\n * Test class getter-only property\n *\n * @remarks\n *\n * Here are some remarks about the getter-only property\n *\n * @virtual\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get testClassGetterProperty(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "testClassGetterProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false }, { "kind": "Method", "canonicalReference": "simple-suite-test!TestClass#testClassMethod:member(1)", "docComment": "/**\n * Test class method\n *\n * @remarks\n *\n * Here are some remarks about the method\n *\n * @throws\n *\n * - An Error\n *\n * @sealed\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testClassMethod(input: " }, { "kind": "Content", "text": "TTypeParameterA" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "TTypeParameterA" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "testClassMethod" }, { "kind": "Property", "canonicalReference": "simple-suite-test!TestClass#testClassProperty:member", "docComment": "/**\n * Test class property\n *\n * @remarks\n *\n * Here are some remarks about the property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly testClassProperty: " }, { "kind": "Content", "text": "TTypeParameterB" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "testClassProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false } ], "implementsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "simple-suite-test!testConst:var", "docComment": "/**\n * Test Constant\n *\n * @remarks\n *\n * Here are some remarks about the variable\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testConst = " }, { "kind": "Content", "text": "42" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "isReadonly": true, "releaseTag": "Public", "name": "testConst", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "Interface", "canonicalReference": "simple-suite-test!TestEmptyInterface:interface", "docComment": "/**\n * An empty interface\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TestEmptyInterface " } ], "releaseTag": "Public", "name": "TestEmptyInterface", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "simple-suite-test!TestEnum:enum", "docComment": "/**\n * Test Enum\n *\n * @remarks\n *\n * Here are some remarks about the enum\n *\n * @example\n *\n * Some example\n * ```typescript\n * const foo = TestEnum.TestEnumValue1\n * ```\n *\n * @example\n *\n * Another example\n * ```ts\n * const bar = TestEnum.TestEnumValue2\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum TestEnum " } ], "releaseTag": "Public", "name": "TestEnum", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "simple-suite-test!TestEnum.TestEnumValue1:member", "docComment": "/**\n * Test enum value 1 (string)\n *\n * @remarks\n *\n * Here are some remarks about the enum value\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestEnumValue1 = " }, { "kind": "Content", "text": "\"test-enum-value-1\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TestEnumValue1" }, { "kind": "EnumMember", "canonicalReference": "simple-suite-test!TestEnum.TestEnumValue2:member", "docComment": "/**\n * Test enum value 2 (number)\n *\n * @remarks\n *\n * Here are some remarks about the enum value\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestEnumValue2 = " }, { "kind": "Content", "text": "3" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TestEnumValue2" }, { "kind": "EnumMember", "canonicalReference": "simple-suite-test!TestEnum.TestEnumValue3:member", "docComment": "/**\n * Test enum value 3 (default)\n *\n * @remarks\n *\n * Here are some remarks about the enum value\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestEnumValue3 = " }, { "kind": "Content", "text": "4" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TestEnumValue3" } ] }, { "kind": "Function", "canonicalReference": "simple-suite-test!testFunction:function(1)", "docComment": "/**\n * Test function\n *\n * @remarks\n *\n * This is a test {@link TestInterface | link} to another API member\n *\n * @param testParameter - A test parameter\n *\n * @typeParam TTypeParameter - A test type parameter\n *\n * @returns The provided parameter\n *\n * @throws\n *\n * - An Error\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function testFunction(testParameter: " }, { "kind": "Content", "text": "TTypeParameter" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "TTypeParameter" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "testParameter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "typeParameters": [ { "typeParameterName": "TTypeParameter", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "testFunction" }, { "kind": "Function", "canonicalReference": "simple-suite-test!testFunctionReturningInlineType:function(1)", "docComment": "/**\n * Test function that returns an inline type\n *\n * @returns An inline type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function testFunctionReturningInlineType(): " }, { "kind": "Content", "text": "{\n foo: number;\n bar: " }, { "kind": "Reference", "text": "TestEnum", "canonicalReference": "simple-suite-test!TestEnum:enum" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testFunctionReturningInlineType" }, { "kind": "Function", "canonicalReference": "simple-suite-test!testFunctionReturningIntersectionType:function(1)", "docComment": "/**\n * Test function that returns an inline type\n *\n * @returns An intersection type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function testFunctionReturningIntersectionType(): " }, { "kind": "Reference", "text": "TestEmptyInterface", "canonicalReference": "simple-suite-test!TestEmptyInterface:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "TestInterfaceWithTypeParameter", "canonicalReference": "simple-suite-test!TestInterfaceWithTypeParameter:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testFunctionReturningIntersectionType" }, { "kind": "Function", "canonicalReference": "simple-suite-test!testFunctionReturningUnionType:function(1)", "docComment": "/**\n * Test function that returns an inline type\n *\n * @returns A union type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function testFunctionReturningUnionType(): " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "TestInterface", "canonicalReference": "simple-suite-test!TestInterface:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testFunctionReturningUnionType" }, { "kind": "Interface", "canonicalReference": "simple-suite-test!TestInterface:interface", "docComment": "/**\n * Test interface\n *\n * @remarks\n *\n * Here are some remarks about the interface\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TestInterface " } ], "releaseTag": "Public", "name": "TestInterface", "preserveMemberOrder": false, "members": [ { "kind": "CallSignature", "canonicalReference": "simple-suite-test!TestInterface:call(1)", "docComment": "/**\n * Test interface event call signature\n *\n * @remarks\n *\n * Here are some remarks about the event call signature\n *\n * @returns A value\n *\n * @eventProperty\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(event: " }, { "kind": "Content", "text": "'testCallSignature'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(input: unknown) => void" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ] }, { "kind": "CallSignature", "canonicalReference": "simple-suite-test!TestInterface:call(2)", "docComment": "/**\n * Another example call signature\n *\n * @remarks\n *\n * Here are some remarks about the event call signature\n *\n * @returns A value\n *\n * @eventProperty\n */\n", "excerptTokens": [ { "kind": "Content", "text": "(event: " }, { "kind": "Content", "text": "'anotherTestCallSignature'" }, { "kind": "Content", "text": ", listener: " }, { "kind": "Content", "text": "(input: number) => string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "listener", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ] }, { "kind": "PropertySignature", "canonicalReference": "simple-suite-test!TestInterface#testClassEventProperty:member", "docComment": "/**\n * Test interface event property\n *\n * @remarks\n *\n * Here are some remarks about the event property\n *\n * @eventProperty\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly testClassEventProperty: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "testClassEventProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "MethodSignature", "canonicalReference": "simple-suite-test!TestInterface#testInterfaceMethod:member(1)", "docComment": "/**\n * Test interface method\n *\n * @remarks\n *\n * Here are some remarks about the method\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testInterfaceMethod(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testInterfaceMethod" }, { "kind": "PropertySignature", "canonicalReference": "simple-suite-test!TestInterface#testInterfaceProperty:member", "docComment": "/**\n * Test interface property\n *\n * @remarks\n *\n * Here are some remarks about the property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testInterfaceProperty: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "testInterfaceProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "simple-suite-test!TestInterfaceExtendingOtherInterfaces:interface", "docComment": "/**\n * Test interface that extends other interfaces\n *\n * @remarks\n *\n * Here are some remarks about the interface\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TestInterfaceExtendingOtherInterfaces extends " }, { "kind": "Reference", "text": "TestInterface", "canonicalReference": "simple-suite-test!TestInterface:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TestInterfaceWithTypeParameter", "canonicalReference": "simple-suite-test!TestInterfaceWithTypeParameter:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TestMappedType", "canonicalReference": "simple-suite-test!TestMappedType:type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TestInterfaceExtendingOtherInterfaces", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "simple-suite-test!TestInterfaceExtendingOtherInterfaces#testMethod:member(1)", "docComment": "/**\n * Test interface method accepting a string and returning a number.\n *\n * @remarks\n *\n * Here are some remarks about the method\n *\n * @param input - A string\n *\n * @returns A number\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testMethod(input: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "testMethod" } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 }, { "startIndex": 6, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "simple-suite-test!TestInterfaceWithTypeParameter:interface", "docComment": "/**\n * Test interface with generic type parameter\n *\n * @remarks\n *\n * Here are some remarks about the interface\n *\n * @typeParam T - A type parameter\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TestInterfaceWithTypeParameter " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "TestInterfaceWithTypeParameter", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "simple-suite-test!TestInterfaceWithTypeParameter#testProperty:member", "docComment": "/**\n * A test interface property using generic type parameter\n *\n * @remarks\n *\n * Here are some remarks about the property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testProperty: " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "testProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "simple-suite-test!TestMappedType:type", "docComment": "/**\n * Test Mapped Type, using {@link TestEnum}\n *\n * @remarks\n *\n * Here are some remarks about the mapped type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type TestMappedType = " }, { "kind": "Content", "text": "{\n [K in " }, { "kind": "Reference", "text": "TestEnum", "canonicalReference": "simple-suite-test!TestEnum:enum" }, { "kind": "Content", "text": "]: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TestMappedType", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Namespace", "canonicalReference": "simple-suite-test!TestNamespace:namespace", "docComment": "/**\n * Test Namespace\n *\n * @remarks\n *\n * Here are some remarks about the namespace\n *\n * @example\n *\n * Example 1\n *\n * @example\n *\n * Example 2\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace TestNamespace " } ], "releaseTag": "Public", "name": "TestNamespace", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "simple-suite-test!TestNamespace.TestClass:class", "docComment": "/**\n * Test class\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "class TestClass " } ], "releaseTag": "Public", "name": "TestClass", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "simple-suite-test!TestNamespace.TestClass:constructor(1)", "docComment": "/**\n * Test class constructor\n *\n * @param testClassProperty - See {@link TestClass.testClassProperty}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(testClassProperty: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "testClassProperty", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "simple-suite-test!TestNamespace.TestClass#testClassMethod:member(1)", "docComment": "/**\n * Test class method\n *\n * @param testParameter - A string\n *\n * @returns A Promise\n *\n * @throws\n *\n * - An Error\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testClassMethod(testParameter: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "testParameter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "name": "testClassMethod" }, { "kind": "Property", "canonicalReference": "simple-suite-test!TestNamespace.TestClass#testClassProperty:member", "docComment": "/**\n * Test interface property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly testClassProperty: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "testClassProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false } ], "implementsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "simple-suite-test!TestNamespace.TestConst:var", "docComment": "/**\n * Test Constant\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestConst = " }, { "kind": "Content", "text": "\"Hello world!\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "isReadonly": true, "releaseTag": "Public", "name": "TestConst", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "Enum", "canonicalReference": "simple-suite-test!TestNamespace.TestEnum:enum", "docComment": "/**\n * Test Enum\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enum TestEnum " } ], "releaseTag": "Public", "name": "TestEnum", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "simple-suite-test!TestNamespace.TestEnum.TestEnumValue1:member", "docComment": "/**\n * Test enum value 1\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestEnumValue1 = " }, { "kind": "Content", "text": "0" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TestEnumValue1" }, { "kind": "EnumMember", "canonicalReference": "simple-suite-test!TestNamespace.TestEnum.TestEnumValue2:member", "docComment": "/**\n * Test enum value 2\n */\n", "excerptTokens": [ { "kind": "Content", "text": "TestEnumValue2 = " }, { "kind": "Content", "text": "1" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "TestEnumValue2" } ] }, { "kind": "Function", "canonicalReference": "simple-suite-test!TestNamespace.testFunction:function(1)", "docComment": "/**\n * Test function\n *\n * @param Foo - A number\n *\n * @returns A number\n *\n * @throws\n *\n * - An Error\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function testFunction(testParameter: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "testParameter", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "testFunction" }, { "kind": "Interface", "canonicalReference": "simple-suite-test!TestNamespace.TestInterface:interface", "docComment": "/**\n * Test interface\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interface TestInterface " } ], "releaseTag": "Public", "name": "TestInterface", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "simple-suite-test!TestNamespace.TestInterface#testInterfaceMethod:member(1)", "docComment": "/**\n * Test interface method\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testInterfaceMethod(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "testInterfaceMethod" }, { "kind": "PropertySignature", "canonicalReference": "simple-suite-test!TestNamespace.TestInterface#testInterfaceProperty:member", "docComment": "/**\n * Test interface property\n */\n", "excerptTokens": [ { "kind": "Content", "text": "testInterfaceProperty: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "testInterfaceProperty", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "simple-suite-test!TestNamespace.TestSubNamespace:namespace", "docComment": "/**\n * Test sub-namespace\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "namespace TestSubNamespace " } ], "releaseTag": "Public", "name": "TestSubNamespace", "preserveMemberOrder": false, "members": [] }, { "kind": "TypeAlias", "canonicalReference": "simple-suite-test!TestNamespace.TypeAlias:type", "docComment": "/**\n * Test Type-Alias\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "type TypeAlias = " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TypeAlias", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "TypeAlias", "canonicalReference": "simple-suite-test!TypeAlias:type", "docComment": "/**\n * Test Type-Alias\n *\n * @remarks\n *\n * Here are some remarks about the type alias\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type TypeAlias = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TypeAlias", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } } ] } ] }