vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

util.promisify: compatible with the latest @types/node (#35270)

Browse Source
This commit is contained in:
Piotr Roszatycki 2019-05-14 00:47:22 +02:00 committed by Nathan Shively-Sanders
parent b3fae8a887
commit 04b191fa7f
6 changed files with 79 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
types/util.promisify/auto.d.ts vendored Normal file
View File

@ -0,0 +1,3 @@
import shim = require("./shim");
export {};

57
types/util.promisify/index.d.ts vendored
View File

@ -1,36 +1,41 @@
// Type definitions for util.promisify 1.0
// Project: https://github.com/ljharb/util.promisify#readme
// Definitions by: Adam Voss <https://github.com/adamvoss>
// Piotr Roszatycki <https://github.com/dex4er>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/*~ Note that ES6 modules cannot directly export callable functions.
*~ This file should be imported using the CommonJS-style:
*~ import x = require('util.promisify');
*~
*~ Refer to the documentation to understand common
*~ workarounds for this limitation of ES6 modules.
*/
export = promisify;
/// <reference types="node" />
declare function promisify(f: (...args: any[]) => void): (...args: any[]) => Promise<any>;
// tslint:disable:ban-types
interface CustomPromisify<TCustom extends Function> extends Function {
__promisify__: TCustom;
}
declare function promisify<TCustom extends Function>(fn: CustomPromisify<TCustom>): TCustom;
declare function promisify<TResult>(fn: (callback: (err: Error | null, result: TResult) => void) => void): () => Promise<TResult>;
declare function promisify(fn: (callback: (err?: Error | null) => void) => void): () => Promise<void>;
declare function promisify<T1, TResult>(fn: (arg1: T1, callback: (err: Error | null, result: TResult) => void) => void): (arg1: T1) => Promise<TResult>;
declare function promisify<T1>(fn: (arg1: T1, callback: (err?: Error | null) => void) => void): (arg1: T1) => Promise<void>;
declare function promisify<T1, T2, TResult>(fn: (arg1: T1, arg2: T2, callback: (err: Error | null, result: TResult) => void) => void): (arg1: T1, arg2: T2) => Promise<TResult>;
declare function promisify<T1, T2>(fn: (arg1: T1, arg2: T2, callback: (err?: Error | null) => void) => void): (arg1: T1, arg2: T2) => Promise<void>;
declare function promisify<T1, T2, T3, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: Error | null, result: TResult) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>;
declare function promisify<T1, T2, T3>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: Error | null) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<void>;
declare function promisify<T1, T2, T3, T4, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: Error | null, result: TResult) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>;
declare function promisify<T1, T2, T3, T4>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: Error | null) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>;
declare function promisify<T1, T2, T3, T4, T5, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: Error | null, result: TResult) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>;
declare function promisify<T1, T2, T3, T4, T5>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: Error | null) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>;
declare function promisify(fn: Function): Function;
declare namespace promisify {
interface implementation {
(fn: (...args: any[]) => void): (...args: any[]) => Promise<any>;
custom: symbol;
customPromisifyArgs: symbol | undefined;
}
const custom: symbol;
const customPromisifyArgs: symbol;
function getPolyfill(): implementation;
const implementation: implementation;
function shim(): implementation;
function getPolyfill(): typeof promisify;
const implementation: typeof promisify;
function shim(): typeof promisify;
}
declare module "util" {
let promisify: {
(fn: (...args: any[]) => void): (...args: any[]) => Promise<any>;
custom: symbol;
};
}
export = promisify;

29
types/util.promisify/polyfill.d.ts vendored Normal file
View File

@ -0,0 +1,29 @@
/// <reference types="node" />
// tslint:disable:ban-types max-line-length
interface CustomPromisify<TCustom extends Function> extends Function {
__promisify__: TCustom;
}
declare function getPolyfill<TCustom extends Function>(): (fn: CustomPromisify<TCustom>) => TCustom;
declare function getPolyfill<TResult>(): (fn: (callback: (err: Error | null, result: TResult) => void) => void) => () => Promise<TResult>;
declare function getPolyfill(): (fn: (callback: (err?: Error | null) => void) => void) => () => Promise<void>;
declare function getPolyfill<T1, TResult>(): (fn: (arg1: T1, callback: (err: Error | null, result: TResult) => void) => void) => (arg1: T1) => Promise<TResult>;
declare function getPolyfill<T1>(): (fn: (arg1: T1, callback: (err?: Error | null) => void) => void) => (arg1: T1) => Promise<void>;
declare function getPolyfill<T1, T2, TResult>(): (fn: (arg1: T1, arg2: T2, callback: (err: Error | null, result: TResult) => void) => void) => (arg1: T1, arg2: T2) => Promise<TResult>;
declare function getPolyfill<T1, T2>(): (fn: (arg1: T1, arg2: T2, callback: (err?: Error | null) => void) => void) => (arg1: T1, arg2: T2) => Promise<void>;
declare function getPolyfill<T1, T2, T3, TResult>(): (fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: Error | null, result: TResult) => void) => void) => (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>;
declare function getPolyfill<T1, T2, T3>(): (fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: Error | null) => void) => void) => (arg1: T1, arg2: T2, arg3: T3) => Promise<void>;
declare function getPolyfill<T1, T2, T3, T4, TResult>(): (
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: Error | null, result: TResult) => void) => void,
) => (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>;
declare function getPolyfill<T1, T2, T3, T4>(): (fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: Error | null) => void) => void) => (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>;
declare function getPolyfill<T1, T2, T3, T4, T5, TResult>(): (
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: Error | null, result: TResult) => void) => void,
) => (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>;
declare function getPolyfill<T1, T2, T3, T4, T5>(): (
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: Error | null) => void) => void,
) => (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>;
declare function getPolyfill(): (fn: Function) => Function;
export = getPolyfill;

3
types/util.promisify/shim.d.ts vendored Normal file
View File

@ -0,0 +1,3 @@
import getPolyfill = require("./polyfill");
export = getPolyfill;

3
types/util.promisify/tsconfig.json
View File

@ -17,7 +17,10 @@
"forceConsistentCasingInFileNames": true
},
"files": [
"auto.d.ts",
"index.d.ts",
"polyfill.d.ts",
"shim.d.ts",
"util.promisify-tests.ts"
]
}

16
types/util.promisify/util.promisify-tests.ts
View File

@ -1,11 +1,15 @@
/// <reference types="node/v0" />
import * as util from 'util';
import * as fs from "fs";
import * as fs from 'fs';
import promisify = require('util.promisify');
// tslint:disable-next-line ban-types
let readFile: Function = promisify(fs.readFile);
import 'util.promisify/auto';
promisify.shim();
let readFile = promisify(fs.readFile);
readFile = util.promisify(fs.readFile);
let implementation = promisify.getPolyfill();
implementation = promisify.shim();
implementation = promisify.implementation;
import promisifyShim = require('util.promisify/shim');
promisifyShim();