Skip to content

Commit d8ab24e

Browse files
iclantoniclanton
committed
Update API files.
1 parent 626017c commit d8ab24e

2 files changed

Lines changed: 260 additions & 0 deletions

File tree

‎common/reviews/api/rush-stack-compiler-3.6.api.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
## API Report File for "@microsoft/rush-stack-compiler-3.6"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import * as ApiExtractor from '@microsoft/api-extractor';
8+
import { ExtractorConfig } from '@microsoft/api-extractor';
9+
import { IExtractorInvokeOptions } from '@microsoft/api-extractor';
10+
import { IPackageJson } from '@microsoft/node-core-library';
11+
import { ITerminalProvider } from '@microsoft/node-core-library';
12+
import { Terminal } from '@microsoft/node-core-library';
13+
import * as Tslint from 'tslint';
14+
import * as Typescript from 'typescript';
15+
16+
// @beta
17+
export class ApiExtractorRunner extends RushStackCompilerBase {
18+
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
19+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
20+
// (undocumented)
21+
static apiExtractor: typeof ApiExtractor;
22+
// (undocumented)
23+
invoke(): Promise<void>;
24+
}
25+
26+
// @public (undocumented)
27+
export interface ILintRunnerConfig extends IRushStackCompilerBaseOptions {
28+
displayAsError?: boolean;
29+
}
30+
31+
// @public (undocumented)
32+
export interface IRushStackCompilerBaseOptions {
33+
// (undocumented)
34+
fileError: WriteFileIssueFunction;
35+
// (undocumented)
36+
fileWarning: WriteFileIssueFunction;
37+
}
38+
39+
// @public (undocumented)
40+
export interface ITslintRunnerConfig extends ILintRunnerConfig {
41+
}
42+
43+
// @beta (undocumented)
44+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
45+
customArgs?: string[];
46+
}
47+
48+
// @beta (undocumented)
49+
export class LintRunner extends RushStackCompilerBase<ILintRunnerConfig> {
50+
constructor(taskOptions: ILintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
51+
// (undocumented)
52+
invoke(): Promise<void>;
53+
}
54+
55+
// @beta (undocumented)
56+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
57+
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
58+
// (undocumented)
59+
protected _fileError: WriteFileIssueFunction;
60+
// (undocumented)
61+
protected _fileWarning: WriteFileIssueFunction;
62+
// (undocumented)
63+
protected _standardBuildFolders: StandardBuildFolders;
64+
// (undocumented)
65+
protected _taskOptions: TOptions;
66+
// (undocumented)
67+
protected _terminal: Terminal;
68+
}
69+
70+
// @beta (undocumented)
71+
export class StandardBuildFolders {
72+
constructor(projectFolderPath: string);
73+
// (undocumented)
74+
readonly distFolderPath: string;
75+
// (undocumented)
76+
readonly libFolderPath: string;
77+
// (undocumented)
78+
readonly projectFolderPath: string;
79+
// (undocumented)
80+
readonly srcFolderPath: string;
81+
// (undocumented)
82+
readonly tempFolderPath: string;
83+
}
84+
85+
// @alpha (undocumented)
86+
export class ToolPackages {
87+
// (undocumented)
88+
static apiExtractor: typeof ApiExtractor;
89+
// (undocumented)
90+
static tslint: typeof Tslint;
91+
// (undocumented)
92+
static typescript: typeof Typescript;
93+
}
94+
95+
// @beta (undocumented)
96+
export class ToolPaths {
97+
// (undocumented)
98+
static readonly eslintPackageJson: IPackageJson;
99+
// (undocumented)
100+
static readonly eslintPackagePath: string;
101+
// (undocumented)
102+
static readonly tslintPackageJson: IPackageJson;
103+
// (undocumented)
104+
static readonly tslintPackagePath: string;
105+
// (undocumented)
106+
static readonly typescriptPackageJson: IPackageJson;
107+
// (undocumented)
108+
static readonly typescriptPackagePath: string;
109+
}
110+
111+
// @beta (undocumented)
112+
export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
113+
constructor(taskOptions: ITslintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
114+
// (undocumented)
115+
invoke(): Promise<void>;
116+
}
117+
118+
// @beta (undocumented)
119+
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
120+
constructor(rootPath: string, terminalProvider: ITerminalProvider);
121+
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
122+
// (undocumented)
123+
invoke(): Promise<void>;
124+
}
125+
126+
// @public (undocumented)
127+
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
128+
129+
130+
```

‎common/reviews/api/rush-stack-compiler-3.7.api.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
## API Report File for "@microsoft/rush-stack-compiler-3.7"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import * as ApiExtractor from '@microsoft/api-extractor';
8+
import { ExtractorConfig } from '@microsoft/api-extractor';
9+
import { IExtractorInvokeOptions } from '@microsoft/api-extractor';
10+
import { IPackageJson } from '@microsoft/node-core-library';
11+
import { ITerminalProvider } from '@microsoft/node-core-library';
12+
import { Terminal } from '@microsoft/node-core-library';
13+
import * as Tslint from 'tslint';
14+
import * as Typescript from 'typescript';
15+
16+
// @beta
17+
export class ApiExtractorRunner extends RushStackCompilerBase {
18+
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
19+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
20+
// (undocumented)
21+
static apiExtractor: typeof ApiExtractor;
22+
// (undocumented)
23+
invoke(): Promise<void>;
24+
}
25+
26+
// @public (undocumented)
27+
export interface ILintRunnerConfig extends IRushStackCompilerBaseOptions {
28+
displayAsError?: boolean;
29+
}
30+
31+
// @public (undocumented)
32+
export interface IRushStackCompilerBaseOptions {
33+
// (undocumented)
34+
fileError: WriteFileIssueFunction;
35+
// (undocumented)
36+
fileWarning: WriteFileIssueFunction;
37+
}
38+
39+
// @public (undocumented)
40+
export interface ITslintRunnerConfig extends ILintRunnerConfig {
41+
}
42+
43+
// @beta (undocumented)
44+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
45+
customArgs?: string[];
46+
}
47+
48+
// @beta (undocumented)
49+
export class LintRunner extends RushStackCompilerBase<ILintRunnerConfig> {
50+
constructor(taskOptions: ILintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
51+
// (undocumented)
52+
invoke(): Promise<void>;
53+
}
54+
55+
// @beta (undocumented)
56+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
57+
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
58+
// (undocumented)
59+
protected _fileError: WriteFileIssueFunction;
60+
// (undocumented)
61+
protected _fileWarning: WriteFileIssueFunction;
62+
// (undocumented)
63+
protected _standardBuildFolders: StandardBuildFolders;
64+
// (undocumented)
65+
protected _taskOptions: TOptions;
66+
// (undocumented)
67+
protected _terminal: Terminal;
68+
}
69+
70+
// @beta (undocumented)
71+
export class StandardBuildFolders {
72+
constructor(projectFolderPath: string);
73+
// (undocumented)
74+
readonly distFolderPath: string;
75+
// (undocumented)
76+
readonly libFolderPath: string;
77+
// (undocumented)
78+
readonly projectFolderPath: string;
79+
// (undocumented)
80+
readonly srcFolderPath: string;
81+
// (undocumented)
82+
readonly tempFolderPath: string;
83+
}
84+
85+
// @alpha (undocumented)
86+
export class ToolPackages {
87+
// (undocumented)
88+
static apiExtractor: typeof ApiExtractor;
89+
// (undocumented)
90+
static tslint: typeof Tslint;
91+
// (undocumented)
92+
static typescript: typeof Typescript;
93+
}
94+
95+
// @beta (undocumented)
96+
export class ToolPaths {
97+
// (undocumented)
98+
static readonly eslintPackageJson: IPackageJson;
99+
// (undocumented)
100+
static readonly eslintPackagePath: string;
101+
// (undocumented)
102+
static readonly tslintPackageJson: IPackageJson;
103+
// (undocumented)
104+
static readonly tslintPackagePath: string;
105+
// (undocumented)
106+
static readonly typescriptPackageJson: IPackageJson;
107+
// (undocumented)
108+
static readonly typescriptPackagePath: string;
109+
}
110+
111+
// @beta (undocumented)
112+
export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
113+
constructor(taskOptions: ITslintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
114+
// (undocumented)
115+
invoke(): Promise<void>;
116+
}
117+
118+
// @beta (undocumented)
119+
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
120+
constructor(rootPath: string, terminalProvider: ITerminalProvider);
121+
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
122+
// (undocumented)
123+
invoke(): Promise<void>;
124+
}
125+
126+
// @public (undocumented)
127+
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
128+
129+
130+
```

0 commit comments

Comments
 (0)