ES6 Promise / Typescript and the Bluebird Promise

Question

I have a nodejs / typescript 2 project and use the es6-promise package. Now i would like to get rid of the extra package because i can target ES6 in typescript directly.

Answer 1

Since there is no [Symbol.toStringTag] in Bluebird, it's incompatible indeed. There are other things that differ Bluebird implementation from native Promise - scheduler, error handling... The correct way to handle this is:

const promise: Promise<type> = Promise.resolve<type>(bluebirdPromise);

If runtime compatibility is not an issue for sure, this can be addressed with type casting only in relatively type-safe manner:

const promise: Promise<type> = <Promise<type>><any><Bluebird<type>>bluebirdPromise;

or

const promise: Promise<type> = <Promise<type>><PromiseLike<type>>bluebirdPromise;

Answer 2

I was dealing with

TS2322: Type 'Bluebird' is not assignable to type 'Promise'. Property '[Symbol.toStringTag]' is missing in type 'Bluebird'.

and found this thread: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/10801

The TL;DR; version of it is to do one of the following:

1. In each of your .ts entry files add the following to overwrite the global promise:

   import * as Bluebird from 'bluebird';

   declare global { export interface Promise<T> extends Bluebird<T> {} }

Or

2. wrap all promises in a Bluebird promise constructor. There is some runtime overhead here and it is listed as an anti pattern on Bluebird's site.

As an aside, I could not get the second option to work, but the first worked fine for me.