LumeWeb
/
p-defer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make resolve and reject values optional in the TypeScript definition (#3)

This commit is contained in:
Dave Gramlich 2019-03-23 01:53:14 -07:00 committed by Sindre Sorhus
parent 897315f950
commit f84a36653e
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
index.d.ts vendored
View File

@ -4,14 +4,14 @@ export interface DeferredPromise<ValueType> {
@param value - The value to resolve the promise with. @param value - The value to resolve the promise with.
*/ */
resolve(value: ValueType | PromiseLike<ValueType>): void; resolve(value?: ValueType | PromiseLike<ValueType>): void;
/** /**
Reject the promise with a provided reason or error. Reject the promise with a provided reason or error.
@param reason - The reason or error to reject the promise with. @param reason - The reason or error to reject the promise with.
*/ */
reject(reason: unknown): void; reject(reason?: unknown): void;
/** /**
The deferred promise. The deferred promise.

2
index.test-d.ts
View File

@ -4,6 +4,8 @@ import pDefer, {DeferredPromise} from '.';
expectType<DeferredPromise<unknown>>(pDefer()); expectType<DeferredPromise<unknown>>(pDefer());
expectType<DeferredPromise<string>>(pDefer<string>()); expectType<DeferredPromise<string>>(pDefer<string>());
pDefer<void>().resolve();
pDefer<string>().resolve('foo'); pDefer<string>().resolve('foo');
pDefer<void>().reject();
pDefer<string>().reject(new Error('foo')); pDefer<string>().reject(new Error('foo'));
expectType<Promise<string>>(pDefer<string>().promise); expectType<Promise<string>>(pDefer<string>().promise);