Skip to content

Commit cc97b73

Browse files
pgonzalpgonzal
committed
Regenerate docs, add the new packages
1 parent 3db9252 commit cc97b73

File tree

266 files changed

+3546
-28
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+3546
-28
lines changed

‎api/api-extractor.externalapihelper.generateapijson.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ExternalApiHelper.generateApiJson method
44

5-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
5+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
66
77

88
**Signature:**

‎api/api-extractor.externalapihelper.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ExternalApiHelper class
44

5-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
5+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
66
77
ExternalApiHelper has the specific use case of generating an API json file from third-party definition files. This class is invoked by the gulp-core-build-typescript gulpfile, where the external package names are hard wired. The job of this method is almost the same as the API Extractor task that is executed on first party packages, with the exception that all packages analyzed here are external packages with definition files.
88

‎api/api-extractor.ianalyzeprojectoptions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# IAnalyzeProjectOptions interface
44

5-
Options for [Extractor.analyzeProject](api-extractor.extractor.analyzeproject.md) .
5+
Options for [Extractor.analyzeProject](api-extractor.extractor.analyzeproject.md)<!-- -->.
66

77
## Properties
88

‎api/api-extractor.iextractorapijsonfileconfig.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Configures how the API JSON files (\*.api.json) will be generated.
99
| Property | Type | Description |
1010
| --- | --- | --- |
1111
| [`enabled`](api-extractor.iextractorapijsonfileconfig.enabled.md) | `boolean` | Whether to generate API JSON files at all. The default is true. |
12-
| [`outputFolder`](api-extractor.iextractorapijsonfileconfig.outputfolder.md) | `string` | Specifies where the \*.api.json file should be written. <p/> The default value is "./dist" |
12+
| [`outputFolder`](api-extractor.iextractorapijsonfileconfig.outputfolder.md) | `string` | Specifies where the \*.api.json file should be written.<p/><!-- -->The default value is "./dist" |
1313

‎api/api-extractor.iextractorapijsonfileconfig.outputfolder.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# IExtractorApiJsonFileConfig.outputFolder property
44

5-
Specifies where the \*.api.json file should be written.
5+
Specifies where the \*.api.json file should be written.
66

7-
The default value is "./dist"
7+
The default value is "./dist"
88

99
**Signature:**
1010
```javascript

‎api/api-extractor.iextractorapireviewfileconfig.apireviewfolder.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# IExtractorApiReviewFileConfig.apiReviewFolder property
44

5-
The file path of the folder containing API review file, relative to the project folder. This is part of an API review workflow: During a build, the API Extractor will output an API file, e.g. "my-project/temp/my-project.api.ts". It will then compare this file against the last reviewed file, e.g. "../api-review/my-project.api.ts" (assuming that apiReviewFolder is "../api-review"). If the files are different, the build will fail with an error message that instructs the developer to update the approved file, and then commit it to Git. When they create a Pull Request, a branch policy will look for changes under "api-review/\*" and require signoff from the appropriate reviewers.
5+
The file path of the folder containing API review file, relative to the project folder. This is part of an API review workflow: During a build, the API Extractor will output an API file, e.g. "my-project/temp/my-project.api.ts". It will then compare this file against the last reviewed file, e.g. "../api-review/my-project.api.ts" (assuming that apiReviewFolder is "../api-review"). If the files are different, the build will fail with an error message that instructs the developer to update the approved file, and then commit it to Git. When they create a Pull Request, a branch policy will look for changes under "api-review/\*" and require signoff from the appropriate reviewers.
66

7-
The default value is "./etc".
7+
The default value is "./etc".
88

9-
Example: "config" (for a standalone project) Example: "../../common/api-review" (for a Git repository with Rush)
9+
Example: "config" (for a standalone project) Example: "../../common/api-review" (for a Git repository with Rush)
1010

1111
**Signature:**
1212
```javascript

‎api/api-extractor.iextractorapireviewfileconfig.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Configures how the API review files (\*.api.ts) will be generated.
88

99
| Property | Type | Description |
1010
| --- | --- | --- |
11-
| [`apiReviewFolder`](api-extractor.iextractorapireviewfileconfig.apireviewfolder.md) | `string` | The file path of the folder containing API review file, relative to the project folder. This is part of an API review workflow: During a build, the API Extractor will output an API file, e.g. "my-project/temp/my-project.api.ts". It will then compare this file against the last reviewed file, e.g. "../api-review/my-project.api.ts" (assuming that apiReviewFolder is "../api-review"). If the files are different, the build will fail with an error message that instructs the developer to update the approved file, and then commit it to Git. When they create a Pull Request, a branch policy will look for changes under "api-review/\*" and require signoff from the appropriate reviewers. <p/> The default value is "./etc". <p/> Example: "config" (for a standalone project) Example: "../../common/api-review" (for a Git repository with Rush) |
11+
| [`apiReviewFolder`](api-extractor.iextractorapireviewfileconfig.apireviewfolder.md) | `string` | The file path of the folder containing API review file, relative to the project folder. This is part of an API review workflow: During a build, the API Extractor will output an API file, e.g. "my-project/temp/my-project.api.ts". It will then compare this file against the last reviewed file, e.g. "../api-review/my-project.api.ts" (assuming that apiReviewFolder is "../api-review"). If the files are different, the build will fail with an error message that instructs the developer to update the approved file, and then commit it to Git. When they create a Pull Request, a branch policy will look for changes under "api-review/\*" and require signoff from the appropriate reviewers.<p/><!-- -->The default value is "./etc".<p/><!-- -->Example: "config" (for a standalone project) Example: "../../common/api-review" (for a Git repository with Rush) |
1212
| [`enabled`](api-extractor.iextractorapireviewfileconfig.enabled.md) | `boolean` | Whether to generate review files at all. The default is true. |
13-
| [`tempFolder`](api-extractor.iextractorapireviewfileconfig.tempfolder.md) | `string` | The \*.api.ts report is saved into this folder. During a production build (i.e. when IExtractorRuntimeOptions.productionBuild=true) the temporary file will be compared with the file in apiReviewFolder; if there are differences, and error will be reported. During a non-production build, the temporary file will be automatically copied to the apiReviewFolder. <p/> The default value is "./temp". |
13+
| [`tempFolder`](api-extractor.iextractorapireviewfileconfig.tempfolder.md) | `string` | The \*.api.ts report is saved into this folder. During a production build (i.e. when IExtractorRuntimeOptions.productionBuild=true) the temporary file will be compared with the file in apiReviewFolder; if there are differences, and error will be reported. During a non-production build, the temporary file will be automatically copied to the apiReviewFolder.<p/><!-- -->The default value is "./temp". |
1414

‎api/api-extractor.iextractorapireviewfileconfig.tempfolder.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# IExtractorApiReviewFileConfig.tempFolder property
44

5-
The \*.api.ts report is saved into this folder. During a production build (i.e. when IExtractorRuntimeOptions.productionBuild=true) the temporary file will be compared with the file in apiReviewFolder; if there are differences, and error will be reported. During a non-production build, the temporary file will be automatically copied to the apiReviewFolder.
5+
The \*.api.ts report is saved into this folder. During a production build (i.e. when IExtractorRuntimeOptions.productionBuild=true) the temporary file will be compared with the file in apiReviewFolder; if there are differences, and error will be reported. During a non-production build, the temporary file will be automatically copied to the apiReviewFolder.
66

7-
The default value is "./temp".
7+
The default value is "./temp".
88

99
**Signature:**
1010
```javascript

‎api/api-extractor.iextractoroptions.localbuild.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# IExtractorOptions.localBuild property
44

5-
Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. This disables certain validation that would normally be performed for a ship/production build. For example, the \*.api.ts review file is automatically local in a debug build.
5+
Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. This disables certain validation that would normally be performed for a ship/production build. For example, the \*.api.ts review file is automatically local in a debug build.
66

7-
The default value is false.
7+
The default value is false.
88

99
**Signature:**
1010
```javascript

‎api/api-extractor.iextractoroptions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ Runtime options for Extractor.
1010
| --- | --- | --- |
1111
| [`compilerProgram`](api-extractor.iextractoroptions.compilerprogram.md) | `ts.Program` | If IExtractorConfig.project.configType = 'runtime', then the TypeScript compiler state must be provided via this option. |
1212
| [`customLogger`](api-extractor.iextractoroptions.customlogger.md) | `Partial<ILogger>` | Allows the caller to handle API Extractor errors; otherwise, they will be logged to the console. |
13-
| [`localBuild`](api-extractor.iextractoroptions.localbuild.md) | `boolean` | Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. This disables certain validation that would normally be performed for a ship/production build. For example, the \*.api.ts review file is automatically local in a debug build. <p/> The default value is false. |
13+
| [`localBuild`](api-extractor.iextractoroptions.localbuild.md) | `boolean` | Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. This disables certain validation that would normally be performed for a ship/production build. For example, the \*.api.ts review file is automatically local in a debug build.<p/><!-- -->The default value is false. |
1414

0 commit comments

Comments
 (0)