Add TypeScript definition by stroncium · Pull Request #85 · sindresorhus/pify

stroncium · 2021-07-15T13:33:26Z

Solves #74

works with generics(up to 6 arguments and 5 returned values)
works with anything except generics for any number of arguments
doesn't use include and exclude for typing, as we can't test RegExp while typing

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

#74: Add TypeScript type definition

sindresorhus · 2021-07-16T15:56:25Z

Not sure whether it's possible to do this here, but did you consider using variadic tuple types? See: sindresorhus/p-all#9

index.test-d.ts

stroncium · 2021-07-16T16:48:20Z

Not sure whether it's possible to do this here, but did you consider using variadic tuple types? See: sindresorhus/p-all#9

My previous attempt to do something along the lines failed to handle generic functions and was typing everything generic as unknown, I found an issue from 2014 I think which kinda pointed me to it being impossible without overloads(though the catch all version in this branch inherits some of it, and works for everything except generics as far as I can tell). But I'll look into this implementation too in case I missed something.

stroncium · 2021-07-18T17:22:53Z

Not sure whether it's possible to do this here, but did you consider using variadic tuple types? See: sindresorhus/p-all#9

@sindresorhus Worked out after some weird massage. Also cleaned up a bit.

sindresorhus · 2021-07-29T22:59:45Z

Many of the return types should be unknown instead of any to make it stricter. Unfortunately, all any's cannot be replaced with unknown in parameters because of TS special behavior of only any.

sindresorhus · 2021-07-29T22:55:12Z

index.test-d.ts

+type R1 = 'R1';
+type R2 = 'R2';
+let someBoolean:boolean = Math.random() > 0.5;
+const a1:A1 = 'A1';


Suggested change

const a1:A1 = 'A1';

const a1: A1 = 'A1';

Applies in many other places

sindresorhus · 2021-07-29T22:55:27Z

index.test-d.ts

+const a1:A1 = 'A1';
+const a2:A2 = 'A2';
+
+let function00 = (cb: (err: Error | undefined) => any) => { };


Suggested change

let function00 = (cb: (err: Error | undefined) => any) => { };

let function00 = (callback: (error: Error | undefined) => any) => {};

Applies in many other places

sindresorhus · 2021-07-29T22:56:08Z

index.test-d.ts

+}));
+
+declare function generic10<A0>(a0:A0, cb:(error: Error | null | undefined) => any): any;
+declare function generic01<R0>(cb:(error:  Error | null | undefined, r0:R0) => any): any;


Suggested change

declare function generic01<R0>(cb:(error: Error | null | undefined, r0:R0) => any): any;

declare function generic01<R0>(callback: (error: Error | null | undefined, r0: R0) => any): any;

sindresorhus · 2021-07-29T22:56:33Z

index.test-d.ts

+declare function realLifeFunction1(url: string, callback: (error?: Error | null | undefined, response?: { statusCode: number }, body?: string) => void): void;
+expectType<(url: string) => Promise<[{ statusCode: number }?, string?]>>(pify(realLifeFunction1, { multiArgs: true }))
+declare function realLifeFunction2(url: string, callback: (response?: { statusCode: number }, body?: string) => void): void;
+expectType<(url: string) => Promise<[{ statusCode: number }?, string?]>>(pify(realLifeFunction2, { multiArgs: true, errorFirst: false }))


Suggested change

expectType<(url: string) => Promise<[{ statusCode: number }?, string?]>>(pify(realLifeFunction2, { multiArgs: true, errorFirst: false }))

expectType<(url: string) => Promise<[{statusCode: number}?, string?]>>(pify(realLifeFunction2, {multiArgs: true, errorFirst: false}))

sindresorhus · 2021-07-29T22:56:49Z

index.test-d.ts

+
+expectAssignable<{
+	readFile: (path: string) => Promise<Buffer | undefined>,
+}>(pify(fs, {exclude:['exists']}));


Suggested change

}>(pify(fs, {exclude:['exists']}));

}>(pify(fs, {exclude: ['exists']}));

sindresorhus · 2021-07-29T22:58:06Z

index.d.ts

+/**
+Returns a `Promise` wrapped version of the supplied function or module.
+@param input - Callback-style function or module whose methods you want to promisify.
+@returns Wrapped version of the supplied function or module.


Suggested change

@returns Wrapped version of the supplied function or module.

@returns Wrapped version of the supplied function or module.

Applies in many other places

sindresorhus · 2021-07-29T22:58:15Z

index.d.ts

+}
+
+/**
+Returns a `Promise` wrapped version of the supplied function or module.


Suggested change

Returns a `Promise` wrapped version of the supplied function or module.

Returns a `Promise` wrapped version of the supplied function or module.

sindresorhus · 2021-07-29T22:59:00Z

index.d.ts

+	T extends [...infer _, (infer R)?] ? R | undefined:
+	never;
+
+type ExceptLast<T extends any[]> = T extends [ ...infer Head, any ] ? Head : any[];


Suggested change

type ExceptLast<T extends any[]> = T extends [ ...infer Head, any ] ? Head : any[];

type ExceptLast<T extends any[]> = T extends [...infer Head, any] ? Head : any[];

sindresorhus · 2021-07-29T23:00:16Z

index.d.ts

+type LastParameter<T extends AnyFunction> = Last<Parameters<T>>;
+type ParametersExceptLast<T extends AnyFunction> = ExceptLast<Parameters<T>>;
+
+type SelectByOptionOr<O extends boolean, TTrue, TFalse> =


The various utility types here need a short doc comment about what they do.

sindresorhus · 2021-07-29T23:01:06Z

index.d.ts

+
+interface PifyOptions {
+	/**
+	By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like `request` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument. This also applies to rejections, where it returns an array of all the callback arguments, including the error.


Suggested change

By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like `request` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument. This also applies to rejections, where it returns an array of all the callback arguments, including the error.

By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like `request` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument. This also applies to rejections, where it returns an array of all the callback arguments, including the error.

sindresorhus · 2021-07-29T23:04:28Z

Are you sure this is the simplest way it could be done? It might be. I'm just hoping there are ways to further simplify it.

sindresorhus · 2021-10-04T07:12:48Z

@stroncium Bump :)

sindresorhus · 2021-11-04T13:59:34Z

Bump

tom-sherman · 2021-12-18T15:16:30Z

Are you sure this is the simplest way it could be done? It might be. I'm just hoping there are ways to further simplify it.

@sindresorhus I think it can be simplified quite a bit, I've made a start over on #86

sindresorhus · 2022-01-23T10:48:05Z

Closing in favor of #86

sindresorhus reviewed Jul 16, 2021

View reviewed changes

index.test-d.ts Outdated Show resolved Hide resolved

Add TypeScript definition

c289203

sindresorhus requested changes Jul 29, 2021

View reviewed changes

tom-sherman mentioned this pull request Dec 18, 2021

Add TypeScript definitions #86

Merged

4 tasks

sindresorhus closed this Jan 23, 2022

	let function00 = (cb: (err: Error \| undefined) => any) => { };
	let function00 = (callback: (error: Error \| undefined) => any) => {};

	declare function generic01<R0>(cb:(error: Error \| null \| undefined, r0:R0) => any): any;
	declare function generic01<R0>(callback: (error: Error \| null \| undefined, r0: R0) => any): any;

	expectType<(url: string) => Promise<[{ statusCode: number }?, string?]>>(pify(realLifeFunction2, { multiArgs: true, errorFirst: false }))
	expectType<(url: string) => Promise<[{statusCode: number}?, string?]>>(pify(realLifeFunction2, {multiArgs: true, errorFirst: false}))

	}>(pify(fs, {exclude:['exists']}));
	}>(pify(fs, {exclude: ['exists']}));

	@returns Wrapped version of the supplied function or module.
	@returns Wrapped version of the supplied function or module.

	Returns a `Promise` wrapped version of the supplied function or module.
	Returns a `Promise` wrapped version of the supplied function or module.

	type ExceptLast<T extends any[]> = T extends [ ...infer Head, any ] ? Head : any[];
	type ExceptLast<T extends any[]> = T extends [...infer Head, any] ? Head : any[];

	By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like `request` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument. This also applies to rejections, where it returns an array of all the callback arguments, including the error.
	By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like `request` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument. This also applies to rejections, where it returns an array of all the callback arguments, including the error.

Uh oh!

Conversation

stroncium commented Jul 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Referenced issues

Uh oh!

sindresorhus commented Jul 16, 2021

Uh oh!

Uh oh!

stroncium commented Jul 16, 2021

Uh oh!

stroncium commented Jul 18, 2021

Uh oh!

sindresorhus commented Jul 29, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus commented Jul 29, 2021

Uh oh!

sindresorhus commented Oct 4, 2021

Uh oh!

sindresorhus commented Nov 4, 2021

Uh oh!

tom-sherman commented Dec 18, 2021

Uh oh!

sindresorhus commented Jan 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stroncium commented Jul 15, 2021 •

edited

Loading