Skip to content

Commit 4dadd55

Browse files
octogonzoctogonz
committed
Fix some warnings detected by the updated API Extractor
1 parent 0abd6db commit 4dadd55

10 files changed

Lines changed: 16 additions & 46 deletions

‎common/reviews/api/node-core-library.api.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,14 @@ export const enum Encoding {
107107

108108
// @public
109109
export class Executable {
110-
// Warning: (ae-incompatible-release-tags) The symbol "spawnSync" is marked as @public, but its signature references "IExecutableSpawnSyncOptions" which is marked as @beta
111110
static spawnSync(filename: string, args: string[], options?: IExecutableSpawnSyncOptions): child_process.SpawnSyncReturns<string>;
112-
// Warning: (ae-incompatible-release-tags) The symbol "tryResolve" is marked as @public, but its signature references "IExecutableResolveOptions" which is marked as @beta
113111
static tryResolve(filename: string, options?: IExecutableResolveOptions): string | undefined;
114112
}
115113

116-
// @beta
114+
// @public
117115
export type ExecutableStdioMapping = 'pipe' | 'ignore' | 'inherit' | ExecutableStdioStreamMapping[];
118116

119-
// @beta
117+
// @public
120118
export type ExecutableStdioStreamMapping = 'pipe' | 'ignore' | 'inherit' | NodeJS.WritableStream | NodeJS.ReadableStream | number | undefined;
121119

122120
// @public
@@ -183,13 +181,13 @@ export interface IConsoleTerminalProviderOptions {
183181
verboseEnabled: boolean;
184182
}
185183

186-
// @beta
184+
// @public
187185
export interface IExecutableResolveOptions {
188186
currentWorkingDirectory?: string;
189187
environment?: NodeJS.ProcessEnv;
190188
}
191189

192-
// @beta
190+
// @public
193191
export interface IExecutableSpawnSyncOptions extends IExecutableResolveOptions {
194192
input?: string;
195193
maxBuffer?: number;

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@ export class ApiExtractorRunner extends RushStackCompilerBase {
2626
// @public (undocumented)
2727
export interface ITslintRunnerConfig {
2828
displayAsError?: boolean;
29-
// Warning: (ae-incompatible-release-tags) The symbol "fileError" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
30-
//
3129
// (undocumented)
3230
fileError: WriteFileIssueFunction;
33-
// Warning: (ae-incompatible-release-tags) The symbol "fileWarning" is marked as @public, but its signature references "WriteFileIssueFunction" which is marked as @beta
34-
//
3531
// (undocumented)
3632
fileWarning: WriteFileIssueFunction;
3733
}
@@ -109,7 +105,7 @@ export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompile
109105
invoke(): Promise<void>;
110106
}
111107

112-
// @beta (undocumented)
108+
// @public (undocumented)
113109
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;
114110

115111

‎libraries/node-core-library/src/Executable.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ import { PosixModeBits } from './PosixModeBits';
1010

1111
/**
1212
* Typings for one of the streams inside IExecutableSpawnSyncOptions.stdio.
13-
* @beta
13+
* @public
1414
*/
1515
export type ExecutableStdioStreamMapping = 'pipe' | 'ignore' | 'inherit'
1616
| NodeJS.WritableStream | NodeJS.ReadableStream
1717
| number | undefined;
1818

1919
/**
2020
* Typings for IExecutableSpawnSyncOptions.stdio.
21-
* @beta
21+
* @public
2222
*/
2323
export type ExecutableStdioMapping = 'pipe' | 'ignore' | 'inherit' | ExecutableStdioStreamMapping[];
2424

2525
/**
2626
* Options for Executable.tryResolve().
27-
* @beta
27+
* @public
2828
*/
2929
export interface IExecutableResolveOptions {
3030
/**
@@ -40,7 +40,7 @@ export interface IExecutableResolveOptions {
4040

4141
/**
4242
* Options for Executable.execute().
43-
* @beta
43+
* @public
4444
*/
4545
export interface IExecutableSpawnSyncOptions extends IExecutableResolveOptions {
4646
/**

‎stack/rush-stack-compiler-shared/src/shared/TslintRunner.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { ToolPaths } from './ToolPaths';
1010
import { RushStackCompilerBase } from './RushStackCompilerBase';
1111

1212
/**
13-
* @beta
13+
* @public
1414
*/
1515
export type WriteFileIssueFunction = (
1616
filePath: string,

0 commit comments

Comments
 (0)