Skip to content

Commit e739d90

Browse files
iclantoniclanton
committed
Some API cleanup around LegacyAdapters.
1 parent 5a813dc commit e739d90

3 files changed

Lines changed: 25 additions & 24 deletions

File tree

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
import * as child_process from 'child_process';
88
import * as fs from 'fs';
99

10-
// @beta
11-
export type callback<TResult, TError> = (error: TError, result: TResult) => void;
12-
1310
// @beta
1411
export class Colors {
1512
// (undocumented)
@@ -377,16 +374,23 @@ export class JsonSchema {
377374
validateObjectWithCallback(jsonObject: Object, errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void): void;
378375
}
379376

380-
// @beta
377+
// @public
381378
export class LegacyAdapters {
382-
static convertCallbackToPromise<TResult, TError>(fn: (cb: callback<TResult, TError>) => void): Promise<TResult>;
379+
static convertCallbackToPromise<TResult, TError>(fn: (cb: LegacyCallback<TResult, TError>) => void): Promise<TResult>;
383380
// (undocumented)
384-
static convertCallbackToPromise<TResult, TError, TArg1>(fn: (arg1: TArg1, cb: callback<TResult, TError>) => void, arg1: TArg1): Promise<TResult>;
381+
static convertCallbackToPromise<TResult, TError, TArg1>(fn: (arg1: TArg1, cb: LegacyCallback<TResult, TError>) => void, arg1: TArg1): Promise<TResult>;
385382
// (undocumented)
386-
static convertCallbackToPromise<TResult, TError, TArg1, TArg2>(fn: (arg1: TArg1, arg2: TArg2, cb: callback<TResult, TError>) => void, arg1: TArg1, arg2: TArg2): Promise<TResult>;
383+
static convertCallbackToPromise<TResult, TError, TArg1, TArg2>(fn: (arg1: TArg1, arg2: TArg2, cb: LegacyCallback<TResult, TError>) => void, arg1: TArg1, arg2: TArg2): Promise<TResult>;
384+
// (undocumented)
385+
static convertCallbackToPromise<TResult, TError, TArg1, TArg2, TArg3>(fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, cb: LegacyCallback<TResult, TError>) => void, arg1: TArg1, arg2: TArg2, arg3: TArg3): Promise<TResult>;
386+
// (undocumented)
387+
static convertCallbackToPromise<TResult, TError, TArg1, TArg2, TArg3, TArg4>(fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, arg4: TArg4, cb: LegacyCallback<TResult, TError>) => void, arg1: TArg1, arg2: TArg2, arg3: TArg3, arg4: TArg4): Promise<TResult>;
387388
static scrubError(error: Error | string | any): Error;
388389
}
389390

391+
// @public
392+
export type LegacyCallback<TResult, TError> = (error: TError, result: TResult) => void;
393+
390394
// @public
391395
export class LockFile {
392396
static acquire(resourceDir: string, resourceName: string, maxWaitMs?: number): Promise<LockFile>;

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

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,56 @@
33

44
/**
55
* Callback used by {@link LegacyAdapters}.
6-
* @beta
76
*/
8-
export type callback<TResult, TError> = (error: TError, result: TResult) => void;
7+
export type LegacyCallback<TResult, TError> = (error: TError, result: TResult) => void;
98

109
/**
1110
* Helper functions used when interacting with APIs that do not follow modern coding practices.
12-
*
13-
* @beta
1411
*/
1512
export class LegacyAdapters {
1613
/**
1714
* This function wraps a function with a callback in a promise.
1815
*/
1916
public static convertCallbackToPromise<TResult, TError>(
20-
fn: (cb: callback<TResult, TError>) => void
17+
fn: (cb: LegacyCallback<TResult, TError>) => void
2118
): Promise<TResult>;
2219
public static convertCallbackToPromise<TResult, TError, TArg1>(
23-
fn: (arg1: TArg1, cb: callback<TResult, TError>) => void,
20+
fn: (arg1: TArg1, cb: LegacyCallback<TResult, TError>) => void,
2421
arg1: TArg1
2522
): Promise<TResult>;
2623
public static convertCallbackToPromise<TResult, TError, TArg1, TArg2>(
27-
fn: (arg1: TArg1, arg2: TArg2, cb: callback<TResult, TError>) => void,
24+
fn: (arg1: TArg1, arg2: TArg2, cb: LegacyCallback<TResult, TError>) => void,
2825
arg1: TArg1,
2926
arg2: TArg2
3027
): Promise<TResult>;
3128
public static convertCallbackToPromise<TResult, TError, TArg1, TArg2, TArg3>(
32-
fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, cb: callback<TResult, TError>) => void,
29+
fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, cb: LegacyCallback<TResult, TError>) => void,
3330
arg1: TArg1,
3431
arg2: TArg2,
3532
arg3: TArg3
3633
): Promise<TResult>;
3734
public static convertCallbackToPromise<TResult, TError, TArg1, TArg2, TArg3, TArg4>(
38-
fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, arg4: TArg4, cb: callback<TResult, TError>) => void,
35+
fn: (arg1: TArg1, arg2: TArg2, arg3: TArg3, arg4: TArg4, cb: LegacyCallback<TResult, TError>) => void,
3936
arg1: TArg1,
4037
arg2: TArg2,
4138
arg3: TArg3,
4239
arg4: TArg4
4340
): Promise<TResult>;
4441
public static convertCallbackToPromise<TResult, TError, TArg1, TArg2, TArg3, TArg4>(
4542
fn: (
46-
a: TArg1 | callback<TResult, TError>,
47-
b?: TArg2 | callback<TResult, TError>,
48-
c?: TArg3 | callback<TResult, TError>,
49-
d?: TArg4 | callback<TResult, TError>,
50-
e?: TArg4 | callback<TResult, TError>
43+
a: TArg1 | LegacyCallback<TResult, TError>,
44+
b?: TArg2 | LegacyCallback<TResult, TError>,
45+
c?: TArg3 | LegacyCallback<TResult, TError>,
46+
d?: TArg4 | LegacyCallback<TResult, TError>,
47+
e?: TArg4 | LegacyCallback<TResult, TError>
5148
) => void,
5249
arg1?: TArg1,
5350
arg2?: TArg2,
5451
arg3?: TArg3,
5552
arg4?: TArg4
5653
): Promise<TResult> {
5754
return new Promise((resolve: (result: TResult) => void, reject: (error: Error) => void) => {
58-
const cb: callback<TResult, TError> = (error: TError, result: TResult) => {
55+
const cb: LegacyCallback<TResult, TError> = (error: TError, result: TResult) => {
5956
if (error) {
6057
reject(LegacyAdapters.scrubError(error));
6158
} else {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export {
7676
} from './FileWriter';
7777
export {
7878
LegacyAdapters,
79-
callback
79+
LegacyCallback
8080
} from './LegacyAdapters';
8181
export { StringBuilder, IStringBuilder } from './StringBuilder';
8282
export { Terminal } from './Terminal/Terminal';
@@ -96,4 +96,4 @@ export {
9696
} from './Terminal/ConsoleTerminalProvider';
9797
export {
9898
StringBufferTerminalProvider
99-
} from './Terminal/StringBufferTerminalProvider';
99+
} from './Terminal/StringBufferTerminalProvider';

0 commit comments

Comments
 (0)