зеркало из https://github.com/microsoft/rushstack.git
Merge branch 'main' into enelson/package-update
This commit is contained in:
Elliot Nelson
Коммит
b717c25380
|
|
@ -1,6 +1,51 @@
|
|||
{
|
||||
"name": "@microsoft/api-documenter",
|
||||
"entries": [
|
||||
{
|
||||
"version": "7.21.2",
|
||||
"tag": "@microsoft/api-documenter_v7.21.2",
|
||||
"date": "Mon, 30 Jan 2023 16:22:30 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.26.1`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "7.21.1",
|
||||
"tag": "@microsoft/api-documenter_v7.21.1",
|
||||
"date": "Mon, 30 Jan 2023 00:55:44 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "7.21.0",
|
||||
"tag": "@microsoft/api-documenter_v7.21.0",
|
||||
"date": "Sun, 29 Jan 2023 20:09:58 GMT",
|
||||
"comments": {
|
||||
"minor": [
|
||||
{
|
||||
"comment": "Fix an issue where `<b>`/`<i>` tags sometimes interfered with parsing of other Markdown on the same line; italics and boldface are now emitted using `*` and `_`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "7.20.1",
|
||||
"tag": "@microsoft/api-documenter_v7.20.1",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,23 @@
|
|||
# Change Log - @microsoft/api-documenter
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:10 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:30 GMT and should not be manually modified.
|
||||
|
||||
## 7.21.2
|
||||
Mon, 30 Jan 2023 16:22:30 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 7.21.1
|
||||
Mon, 30 Jan 2023 00:55:44 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 7.21.0
|
||||
Sun, 29 Jan 2023 20:09:58 GMT
|
||||
|
||||
### Minor changes
|
||||
|
||||
- Fix an issue where `<b>`/`<i>` tags sometimes interfered with parsing of other Markdown on the same line; italics and boldface are now emitted using `*` and `_`
|
||||
|
||||
## 7.20.1
|
||||
Thu, 26 Jan 2023 02:55:10 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@microsoft/api-documenter",
|
||||
"version": "7.20.1",
|
||||
"version": "7.21.2",
|
||||
"description": "Read JSON files from api-extractor, generate documentation pages",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
|
|
|||
|
|
@ -250,19 +250,19 @@ export class MarkdownEmitter {
|
|||
}
|
||||
|
||||
if (context.boldRequested) {
|
||||
writer.write('<b>');
|
||||
writer.write('**');
|
||||
}
|
||||
if (context.italicRequested) {
|
||||
writer.write('<i>');
|
||||
writer.write('_');
|
||||
}
|
||||
|
||||
writer.write(this.getEscapedText(middle));
|
||||
|
||||
if (context.italicRequested) {
|
||||
writer.write('</i>');
|
||||
writer.write('_');
|
||||
}
|
||||
if (context.boldRequested) {
|
||||
writer.write('</b>');
|
||||
writer.write('**');
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -159,7 +159,12 @@ test('render Markdown from TSDoc', () => {
|
|||
new DocParagraph({ configuration }, [new DocPlainText({ configuration, text: 'Cell 1' })])
|
||||
]),
|
||||
new DocTableCell({ configuration }, [
|
||||
new DocParagraph({ configuration }, [new DocPlainText({ configuration, text: 'Cell 2' })])
|
||||
new DocParagraph({ configuration }, [new DocPlainText({ configuration, text: 'Cell 2' })]),
|
||||
new DocParagraph({ configuration }, [
|
||||
new DocEmphasisSpan({ configuration, bold: true }, [
|
||||
new DocPlainText({ configuration, text: 'bold text' })
|
||||
])
|
||||
])
|
||||
])
|
||||
])
|
||||
]
|
||||
|
|
@ -176,5 +181,6 @@ test('render Markdown from TSDoc', () => {
|
|||
}
|
||||
});
|
||||
|
||||
expect(stringBuilder).toMatchSnapshot();
|
||||
expect(stringBuilder.toString()).toMatchSnapshot();
|
||||
console.log(stringBuilder.toString());
|
||||
});
|
||||
|
|
|
|||
|
|
@ -1,12 +1,10 @@
|
|||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||
|
||||
exports[`render Markdown from TSDoc 1`] = `
|
||||
StringBuilder {
|
||||
"_chunks": Array [
|
||||
"
|
||||
"
|
||||
## Simple bold test
|
||||
|
||||
This is a <b>bold</b> word.
|
||||
This is a **bold** word.
|
||||
|
||||
## All whitespace bold
|
||||
|
||||
|
|
@ -14,27 +12,27 @@ This is a <b>bold</b> word.
|
|||
|
||||
## Newline bold
|
||||
|
||||
<b>line 1</b> <b>line 2</b>
|
||||
**line 1** **line 2**
|
||||
|
||||
## Newline bold with spaces
|
||||
|
||||
<b>line 1</b> <b>line 2</b> <b>line 3</b>
|
||||
**line 1** **line 2** **line 3**
|
||||
|
||||
## Adjacent bold regions
|
||||
|
||||
<b>one</b><b>two</b> <b>three</b> <b>four</b>non-bold<!-- --><b>five</b>
|
||||
**one**<!-- -->**two** **three** **four**<!-- -->non-bold<!-- -->**five**
|
||||
|
||||
## Adjacent to other characters
|
||||
|
||||
[a link](./index.md)<!-- --><b>bold</b>non-boldmore-non-bold
|
||||
[a link](./index.md)<!-- -->**bold**<!-- -->non-boldmore-non-bold
|
||||
|
||||
## Unknown block tag
|
||||
|
||||
<b>bold</b>non-boldmore-non-bold
|
||||
**bold**<!-- -->non-boldmore-non-bold
|
||||
|
||||
## Bad characters
|
||||
|
||||
<b>\\\\*one\\\\*two\\\\*</b><b>three\\\\*four</b>
|
||||
**\\\\*one\\\\*two\\\\***<!-- -->**three\\\\*four**
|
||||
|
||||
## Characters that should be escaped
|
||||
|
||||
|
|
@ -54,9 +52,7 @@ HTML escape: &quot;
|
|||
|
||||
| Header 1 | Header 2 |
|
||||
| --- | --- |
|
||||
| Cell 1 | Cell 2 |
|
||||
| Cell 1 | <p>Cell 2</p><p>**bold text**</p> |
|
||||
|
||||
",
|
||||
],
|
||||
}
|
||||
"
|
||||
`;
|
||||
|
|
|
|||
|
|
@ -1,6 +1,21 @@
|
|||
{
|
||||
"name": "@microsoft/api-extractor",
|
||||
"entries": [
|
||||
{
|
||||
"version": "7.34.1",
|
||||
"tag": "@microsoft/api-extractor_v7.34.1",
|
||||
"date": "Mon, 30 Jan 2023 16:22:30 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.26.1`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "7.34.0",
|
||||
"tag": "@microsoft/api-extractor_v7.34.0",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
# Change Log - @microsoft/api-extractor
|
||||
|
||||
This log was last generated on Wed, 25 Jan 2023 07:26:55 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:30 GMT and should not be manually modified.
|
||||
|
||||
## 7.34.1
|
||||
Mon, 30 Jan 2023 16:22:30 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 7.34.0
|
||||
Wed, 25 Jan 2023 07:26:55 GMT
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
@ECHO OFF
|
||||
@SETLOCAL
|
||||
rush build -t api-extractor-lib1-test -t api-extractor-lib2-test -t api-extractor-lib3-test -t api-extractor-scenarios -t api-extractor-test-01 -t api-extractor-test-02 -t api-extractor-test-03 -t api-extractor-test-04 -t api-documenter-test
|
||||
rush test -t api-extractor-lib1-test -t api-extractor-lib2-test -t api-extractor-lib3-test -t api-extractor-scenarios -t api-extractor-test-01 -t api-extractor-test-02 -t api-extractor-test-03 -t api-extractor-test-04 -t api-documenter-test
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@microsoft/api-extractor",
|
||||
"version": "7.34.0",
|
||||
"version": "7.34.1",
|
||||
"description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
|
||||
"keywords": [
|
||||
"typescript",
|
||||
|
|
@ -52,8 +52,8 @@
|
|||
},
|
||||
"devDependencies": {
|
||||
"@rushstack/eslint-config": "workspace:*",
|
||||
"@rushstack/heft": "0.48.0",
|
||||
"@rushstack/heft-node-rig": "1.11.0",
|
||||
"@rushstack/heft": "0.49.3",
|
||||
"@rushstack/heft-node-rig": "1.11.14",
|
||||
"@types/heft-jest": "1.0.1",
|
||||
"@types/lodash": "4.14.116",
|
||||
"@types/node": "14.18.36",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,24 @@
|
|||
{
|
||||
"name": "@rushstack/heft",
|
||||
"entries": [
|
||||
{
|
||||
"version": "0.49.4",
|
||||
"tag": "@rushstack/heft_v0.49.4",
|
||||
"date": "Mon, 30 Jan 2023 16:22:30 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.6`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.1`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "0.49.3",
|
||||
"tag": "@rushstack/heft_v0.49.3",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
# Change Log - @rushstack/heft
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:10 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:30 GMT and should not be manually modified.
|
||||
|
||||
## 0.49.4
|
||||
Mon, 30 Jan 2023 16:22:30 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 0.49.3
|
||||
Thu, 26 Jan 2023 02:55:10 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@rushstack/heft",
|
||||
"version": "0.49.3",
|
||||
"version": "0.49.4",
|
||||
"description": "Build all your JavaScript projects the same way: A way that works.",
|
||||
"keywords": [
|
||||
"toolchain",
|
||||
|
|
@ -52,8 +52,8 @@
|
|||
"devDependencies": {
|
||||
"@microsoft/api-extractor": "workspace:*",
|
||||
"@rushstack/eslint-config": "workspace:*",
|
||||
"@rushstack/heft": "0.48.0",
|
||||
"@rushstack/heft-node-rig": "1.11.0",
|
||||
"@rushstack/heft": "0.49.3",
|
||||
"@rushstack/heft-node-rig": "1.11.14",
|
||||
"@types/argparse": "1.0.38",
|
||||
"@types/eslint": "8.2.0",
|
||||
"@types/glob": "7.1.1",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,14 @@
|
|||
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
||||
// See LICENSE in the project root for license information.
|
||||
|
||||
/**
|
||||
* Heft is a config-driven toolchain that invokes other popular tools such
|
||||
* as TypeScript, ESLint, Jest, Webpack, and API Extractor. You can use it to build
|
||||
* web applications, Node.js services, command-line tools, libraries, and more.
|
||||
*
|
||||
* @packageDocumentation
|
||||
*/
|
||||
|
||||
export { IHeftPlugin } from './pluginFramework/IHeftPlugin';
|
||||
export {
|
||||
HeftConfiguration,
|
||||
|
|
|
|||
|
|
@ -1,6 +1,36 @@
|
|||
{
|
||||
"name": "@rushstack/lockfile-explorer",
|
||||
"entries": [
|
||||
{
|
||||
"version": "1.0.4",
|
||||
"tag": "@rushstack/lockfile-explorer_v1.0.4",
|
||||
"date": "Mon, 30 Jan 2023 16:22:31 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "1.0.3",
|
||||
"tag": "@rushstack/lockfile-explorer_v1.0.3",
|
||||
"date": "Mon, 30 Jan 2023 00:55:44 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "1.0.2",
|
||||
"tag": "@rushstack/lockfile-explorer_v1.0.2",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,16 @@
|
|||
# Change Log - @rushstack/lockfile-explorer
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:10 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:31 GMT and should not be manually modified.
|
||||
|
||||
## 1.0.4
|
||||
Mon, 30 Jan 2023 16:22:31 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 1.0.3
|
||||
Mon, 30 Jan 2023 00:55:44 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 1.0.2
|
||||
Thu, 26 Jan 2023 02:55:10 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@rushstack/lockfile-explorer",
|
||||
"version": "1.0.2",
|
||||
"version": "1.0.4",
|
||||
"description": "Rush Lockfile Explorer: The UI for solving version conflicts quickly in a large monorepo",
|
||||
"keywords": [
|
||||
"conflict",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,36 @@
|
|||
{
|
||||
"name": "@rushstack/rundown",
|
||||
"entries": [
|
||||
{
|
||||
"version": "1.0.239",
|
||||
"tag": "@rushstack/rundown_v1.0.239",
|
||||
"date": "Mon, 30 Jan 2023 16:22:31 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "1.0.238",
|
||||
"tag": "@rushstack/rundown_v1.0.238",
|
||||
"date": "Mon, 30 Jan 2023 00:55:44 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "1.0.237",
|
||||
"tag": "@rushstack/rundown_v1.0.237",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,16 @@
|
|||
# Change Log - @rushstack/rundown
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:10 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:31 GMT and should not be manually modified.
|
||||
|
||||
## 1.0.239
|
||||
Mon, 30 Jan 2023 16:22:31 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 1.0.238
|
||||
Mon, 30 Jan 2023 00:55:44 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 1.0.237
|
||||
Thu, 26 Jan 2023 02:55:10 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@rushstack/rundown",
|
||||
"version": "1.0.237",
|
||||
"version": "1.0.239",
|
||||
"description": "Detect load time regressions by running an app, tracing require() calls, and generating a deterministic report",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,18 @@
|
|||
{
|
||||
"name": "@microsoft/rush",
|
||||
"entries": [
|
||||
{
|
||||
"version": "5.90.0",
|
||||
"tag": "@microsoft/rush_v5.90.0",
|
||||
"date": "Sun, 29 Jan 2023 20:10:17 GMT",
|
||||
"comments": {
|
||||
"none": [
|
||||
{
|
||||
"comment": "Allow \"shellCommand\" to be optionally specified for bulk custom commands, so that a centralized script can be used instead of invoking package.json scripts (GitHub #3819)"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "5.89.1",
|
||||
"tag": "@microsoft/rush_v5.89.1",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,13 @@
|
|||
# Change Log - @microsoft/rush
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:30 GMT and should not be manually modified.
|
||||
This log was last generated on Sun, 29 Jan 2023 20:10:17 GMT and should not be manually modified.
|
||||
|
||||
## 5.90.0
|
||||
Sun, 29 Jan 2023 20:10:17 GMT
|
||||
|
||||
### Updates
|
||||
|
||||
- Allow "shellCommand" to be optionally specified for bulk custom commands, so that a centralized script can be used instead of invoking package.json scripts (GitHub #3819)
|
||||
|
||||
## 5.89.1
|
||||
Thu, 26 Jan 2023 02:55:30 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@microsoft/rush",
|
||||
"version": "5.89.1",
|
||||
"version": "5.90.0",
|
||||
"description": "A professional solution for consolidating all your JavaScript projects in one Git repo",
|
||||
"keywords": [
|
||||
"install",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,36 @@
|
|||
{
|
||||
"name": "@rushstack/trace-import",
|
||||
"entries": [
|
||||
{
|
||||
"version": "0.1.8",
|
||||
"tag": "@rushstack/trace-import_v0.1.8",
|
||||
"date": "Mon, 30 Jan 2023 16:22:31 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
|
||||
},
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "0.1.7",
|
||||
"tag": "@rushstack/trace-import_v0.1.7",
|
||||
"date": "Mon, 30 Jan 2023 00:55:44 GMT",
|
||||
"comments": {
|
||||
"dependency": [
|
||||
{
|
||||
"comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"version": "0.1.6",
|
||||
"tag": "@rushstack/trace-import_v0.1.6",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,16 @@
|
|||
# Change Log - @rushstack/trace-import
|
||||
|
||||
This log was last generated on Thu, 26 Jan 2023 02:55:10 GMT and should not be manually modified.
|
||||
This log was last generated on Mon, 30 Jan 2023 16:22:31 GMT and should not be manually modified.
|
||||
|
||||
## 0.1.8
|
||||
Mon, 30 Jan 2023 16:22:31 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 0.1.7
|
||||
Mon, 30 Jan 2023 00:55:44 GMT
|
||||
|
||||
_Version update only_
|
||||
|
||||
## 0.1.6
|
||||
Thu, 26 Jan 2023 02:55:10 GMT
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@rushstack/trace-import",
|
||||
"version": "0.1.6",
|
||||
"version": "0.1.8",
|
||||
"description": "CLI tool for understanding how require() and \"import\" statements get resolved",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
"@types/webpack-env": "1.18.0",
|
||||
"babel-loader": "~8.2.3",
|
||||
"css-loader": "~5.2.7",
|
||||
"jest": "~27.4.2",
|
||||
"jest": "~29.3.1",
|
||||
"react-dom": "~16.13.1",
|
||||
"react": "~16.13.1",
|
||||
"style-loader": "~2.0.0",
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A fourth prop
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
fourthProp: number;
|
||||
|
|
|
|||
|
|
@ -5,12 +5,12 @@
|
|||
## Class1 class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class Class1 extends Class2<number>
|
||||
```
|
||||
<b>Extends:</b> [Class2](./api-documenter-scenarios.class2.md)<!-- --><number>
|
||||
**Extends:** [Class2](./api-documenter-scenarios.class2.md)<!-- --><number>
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A second prop. Overrides `Class2.secondProp`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
secondProp: boolean;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some overload. Overrides `Class3.someOverload`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someOverload(x: boolean | string): void;
|
||||
|
|
@ -18,7 +18,7 @@ someOverload(x: boolean | string): void;
|
|||
| --- | --- | --- |
|
||||
| x | boolean \| string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -5,12 +5,12 @@
|
|||
## Class2 class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class Class2<T> extends Namespace1.Class3
|
||||
```
|
||||
<b>Extends:</b> [Namespace1.Class3](./api-documenter-scenarios.namespace1.class3.md)
|
||||
**Extends:** [Namespace1.Class3](./api-documenter-scenarios.namespace1.class3.md)
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A second prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
secondProp: boolean | string;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some method. Overrides `Class3.someMethod`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someMethod(x: boolean): void;
|
||||
|
|
@ -18,7 +18,7 @@ someMethod(x: boolean): void;
|
|||
| --- | --- | --- |
|
||||
| x | boolean | |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A third prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
thirdProp: T;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some class-like variable.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
ClassLikeVariable: {
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some class that extends an anonymous class.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class ExtendsAnonymousClass extends ExtendsAnonymousClass_base
|
||||
```
|
||||
<b>Extends:</b> ExtendsAnonymousClass\_base
|
||||
**Extends:** ExtendsAnonymousClass\_base
|
||||
|
||||
<i>(Some inherited members may not be shown because they are not represented in the documentation.)</i>
|
||||
_(Some inherited members may not be shown because they are not represented in the documentation.)_
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some class that extends a class from another package. This base class is not in any API doc model.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class ExtendsClassFromAnotherPackage extends Extractor
|
||||
```
|
||||
<b>Extends:</b> Extractor
|
||||
**Extends:** Extractor
|
||||
|
||||
<i>(Some inherited members may not be shown because they are not represented in the documentation.)</i>
|
||||
_(Some inherited members may not be shown because they are not represented in the documentation.)_
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some class that extends a class-like variable.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class ExtendsClassLikeVariable extends ClassLikeVariable
|
||||
```
|
||||
<b>Extends:</b> ClassLikeVariable
|
||||
**Extends:** ClassLikeVariable
|
||||
|
||||
<i>(Some inherited members may not be shown because they are not represented in the documentation.)</i>
|
||||
_(Some inherited members may not be shown because they are not represented in the documentation.)_
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some class that extends an unexported class.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class ExtendsUnexportedClass extends UnexportedClass
|
||||
```
|
||||
<b>Extends:</b> UnexportedClass
|
||||
**Extends:** UnexportedClass
|
||||
|
||||
<i>(Some inherited members may not be shown because they are not represented in the documentation.)</i>
|
||||
_(Some inherited members may not be shown because they are not represented in the documentation.)_
|
||||
|
||||
|
|
|
|||
|
|
@ -6,14 +6,14 @@
|
|||
|
||||
Some interface that extends an interface-like type alias as well as another interface.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface IExtendsInterfaceLikeTypeAlias extends IInterfaceLikeTypeAlias, IInterface1
|
||||
```
|
||||
<b>Extends:</b> [IInterfaceLikeTypeAlias](./api-documenter-scenarios.iinterfaceliketypealias.md)<!-- -->, [IInterface1](./api-documenter-scenarios.iinterface1.md)
|
||||
**Extends:** [IInterfaceLikeTypeAlias](./api-documenter-scenarios.iinterfaceliketypealias.md)<!-- -->, [IInterface1](./api-documenter-scenarios.iinterface1.md)
|
||||
|
||||
<i>(Some inherited members may not be shown because they are not represented in the documentation.)</i>
|
||||
_(Some inherited members may not be shown because they are not represented in the documentation.)_
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some interface that extends multiple interfaces.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface IExtendsMultipleInterfaces extends IInterface1, IInterface2
|
||||
```
|
||||
<b>Extends:</b> [IInterface1](./api-documenter-scenarios.iinterface1.md)<!-- -->, [IInterface2](./api-documenter-scenarios.iinterface2.md)
|
||||
**Extends:** [IInterface1](./api-documenter-scenarios.iinterface1.md)<!-- -->, [IInterface2](./api-documenter-scenarios.iinterface2.md)
|
||||
|
||||
## Properties
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A second prop. Overrides `IInterface1.someProp`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
secondProp: boolean;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A third prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
thirdProp: string;
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## IInterface1 interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface IInterface1
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A second prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
secondProp: boolean | string;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someProp: number;
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## IInterface2 interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface IInterface2
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someProp: number;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some interface-like type alias.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare type IInterfaceLikeTypeAlias = {
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## Namespace1.Class3 class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
class Class3
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some method.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someMethod(x: boolean | string): void;
|
||||
|
|
@ -18,7 +18,7 @@ someMethod(x: boolean | string): void;
|
|||
| --- | --- | --- |
|
||||
| x | boolean \| string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some overload.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someOverload(x: boolean): void;
|
||||
|
|
@ -18,7 +18,7 @@ someOverload(x: boolean): void;
|
|||
| --- | --- | --- |
|
||||
| x | boolean | |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some overload.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someOverload(x: string): void;
|
||||
|
|
@ -18,7 +18,7 @@ someOverload(x: string): void;
|
|||
| --- | --- | --- |
|
||||
| x | string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some prop.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
someProp: number;
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## Namespace1 namespace
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare namespace Namespace1
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
"@microsoft/api-extractor": "workspace:*",
|
||||
"@microsoft/teams-js": "1.3.0-beta.4",
|
||||
"@rushstack/node-core-library": "workspace:*",
|
||||
"@types/jest": "27.4.0",
|
||||
"@types/jest": "29.2.5",
|
||||
"@types/node": "14.18.36",
|
||||
"fs-extra": "~7.0.1",
|
||||
"typescript": "~4.8.4"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some abstract class with abstract members.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare abstract class AbstractClass
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
Some abstract method.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
abstract method(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some abstract property.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
protected abstract property: number;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Type parameter constraint used by test case below.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface Constraint
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
An exported variable declaration.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
constVariable: number
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
The date when the record was created.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
creationDate: Date;
|
||||
```
|
||||
<b>Decorators:</b>
|
||||
**Decorators:**
|
||||
|
||||
`@jsonSerialized`
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## DecoratorExample class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class DecoratorExample
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Type parameter default type used by test case below.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface DefaultType
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
The simple constructor for `DocBaseClass`
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
constructor();
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
The overloaded constructor for `DocBaseClass`
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
constructor(x: number);
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
Example base class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class DocBaseClass
|
||||
|
|
|
|||
|
|
@ -9,12 +9,12 @@
|
|||
> Use `otherThing()` instead.
|
||||
>
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
deprecatedExample(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This is an overloaded function.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
exampleFunction(a: string, b: string): string;
|
||||
|
|
@ -19,7 +19,7 @@ exampleFunction(a: string, b: string): string;
|
|||
| a | string | the first string |
|
||||
| b | string | the second string |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
string
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This is also an overloaded function.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
exampleFunction(x: number): number;
|
||||
|
|
@ -18,7 +18,7 @@ exampleFunction(x: number): number;
|
|||
| --- | --- | --- |
|
||||
| x | number | the number |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
number
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This is a method with a complex type parameter.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
genericWithConstraintAndDefault<T extends Constraint = DefaultType>(x: T): void;
|
||||
|
|
@ -18,7 +18,7 @@ genericWithConstraintAndDefault<T extends Constraint = DefaultType>(x: T): void;
|
|||
| --- | --- | --- |
|
||||
| x | T | some generic parameter. |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,12 @@ Example: "<!-- -->{ \\<!-- -->"maxItemsToShow<!-- -->\\<!-- -->": 123 }<!-- -->"
|
|||
|
||||
The regular expression used to validate the constraints is /^\[a-zA-Z0-9<!-- -->\\<!-- -->-\_\]+$/
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
interestingEdgeCases(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This event should have been marked as readonly.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
malformedEvent: SystemEvent;
|
||||
|
|
|
|||
|
|
@ -6,14 +6,14 @@
|
|||
|
||||
This is an example class.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInterface2
|
||||
```
|
||||
<b>Extends:</b> [DocBaseClass](./api-documenter-test.docbaseclass.md)
|
||||
**Extends:** [DocBaseClass](./api-documenter-test.docbaseclass.md)
|
||||
|
||||
<b>Implements:</b> [IDocInterface1](./api-documenter-test.idocinterface1.md)<!-- -->, [IDocInterface2](./api-documenter-test.idocinterface2.md)
|
||||
**Implements:** [IDocInterface1](./api-documenter-test.idocinterface1.md)<!-- -->, [IDocInterface2](./api-documenter-test.idocinterface2.md)
|
||||
|
||||
## Remarks
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This event is fired whenever the object is modified.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
readonly modifiedEvent: SystemEvent;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some property with multiple modifiers.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
protected static readonly multipleModifiersProperty: boolean;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This is a function with an optional parameter.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
optionalParamFunction(x?: number): void;
|
||||
|
|
@ -16,9 +16,9 @@ optionalParamFunction(x?: number): void;
|
|||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| x | number | <i>(Optional)</i> the number |
|
||||
| x | number | _(Optional)_ the number |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Some protected property.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
protected protectedProperty: string;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## DocClass1.readonlyProperty property
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
get readonlyProperty(): string;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
This is a regular property that happens to use the SystemEvent type.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
regularProperty: SystemEvent;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Returns the sum of two numbers.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
static sumWithExample(x: number, y: number): number;
|
||||
|
|
@ -19,7 +19,7 @@ static sumWithExample(x: number, y: number): number;
|
|||
| x | number | the first number to add |
|
||||
| y | number | the second number to add |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
number
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
An example with tables:
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
tableExample(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## DocClass1.writeableProperty property
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
get writeableProperty(): string;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
API Extractor will surface an `ae-missing-getter` finding for this property.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
set writeonlyProperty(value: string);
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Interface that merges with class
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface DocClassInterfaceMerge
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
Docs for DocEnum
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare enum DocEnum
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@
|
|||
|
||||
This is a function inside of a namespace that merges with an enum.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
function exampleFunction(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Namespace that merges with enum
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare namespace DocEnumNamespaceMerge
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
An ECMAScript symbol
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
example: unique symbol
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A namespace containing an ECMAScript symbol
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare namespace EcmaSmbols
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@
|
|||
|
||||
A type alias that has duplicate references.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare type ExampleDuplicateTypeAlias = SystemEvent | typeof SystemEvent;
|
||||
```
|
||||
<b>References:</b> [SystemEvent](./api-documenter-test.systemevent.md)
|
||||
**References:** [SystemEvent](./api-documenter-test.systemevent.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
An exported function with hyperlinked parameters and return value.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInterface1;
|
||||
|
|
@ -19,7 +19,7 @@ export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInt
|
|||
| x | [ExampleTypeAlias](./api-documenter-test.exampletypealias.md) | an API item that should get hyperlinked |
|
||||
| y | number | a system type that should NOT get hyperlinked |
|
||||
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
[IDocInterface1](./api-documenter-test.idocinterface1.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
A type alias
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare type ExampleTypeAlias = Promise<boolean>;
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@
|
|||
|
||||
A type alias that references multiple other types.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare type ExampleUnionTypeAlias = IDocInterface1 | IDocInterface3;
|
||||
```
|
||||
<b>References:</b> [IDocInterface1](./api-documenter-test.idocinterface1.md)<!-- -->, [IDocInterface3](./api-documenter-test.idocinterface3.md)
|
||||
**References:** [IDocInterface1](./api-documenter-test.idocinterface1.md)<!-- -->, [IDocInterface3](./api-documenter-test.idocinterface3.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Generic class.
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare class Generic<T>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## GenericTypeAlias type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export declare type GenericTypeAlias<T> = T[];
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
## IDocInterface1 interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
export interface IDocInterface1
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
Does something
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
regularProperty: SystemEvent;
|
||||
|
|
|
|||
|
|
@ -9,12 +9,12 @@
|
|||
> Use `otherThing()` instead.
|
||||
>
|
||||
|
||||
<b>Signature:</b>
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
deprecatedExample(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче