"The Power of ES6 Promises in TypeScript and Harnessing the Strength of Bluebird Prom

Question

"The Power of ES6 Promises in TypeScript and Harnessing the Strength of Bluebird Prom

I'm currently working on a nodejs/typescript 2 project that utilizes the es6-promise package from GitHub. However, I've decided to eliminate this dependency and target ES6 directly in typescript.

After removing the es6-promise package, I updated my tsconfig.json file to set the target as es6.

{
  "compilerOptions": {
    "target": "es6",
    // ...
  }
}

Some third-party packages rely on Bluebird promises, which are not compatible with the default ES6 promise. This issue has been documented on various GitHub posts:

This inconsistency is causing the following error:

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

There is another types package available on npm called @types/bluebird-global. In a blog post, it was recommended to use this package instead of @types/bluebird, but certain third-party packages (e.g., sequelize typings) reference bluebird and not bluebird-global, resulting in another error for the missing typings of bluebird.

What would be an effective solution to resolve this issue?

javascript typescript ecmascript-6 bluebird

Answer 1

Answer №1

My situation involved

Encountered TS2322 error: Type 'Bluebird' is not compatible with type 'Promise'. Missing property '[Symbol.toStringTag]' in type 'Bluebird'.

During my search for a solution, I stumbled upon this discussion: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/10801

To summarize, here are the options:

Add the following code to each of your .ts entry files to override the global promise:

import * as Bluebird from 'bluebird';

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

Alternatively,

Wrap all promises within a Bluebird promise constructor. This method might introduce some runtime overhead and is considered an anti-pattern on Bluebird's website.

On a side note, I personally had success with the first option while encountering challenges with the second one.

Answer 2

My situation involved

Encountered TS2322 error: Type 'Bluebird' is not compatible with type 'Promise'. Missing property '[Symbol.toStringTag]' in type 'Bluebird'.

During my search for a solution, I stumbled upon this discussion: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/10801

To summarize, here are the options:

Add the following code to each of your .ts entry files to override the global promise:

import * as Bluebird from 'bluebird';

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

Alternatively,

Wrap all promises within a Bluebird promise constructor. This method might introduce some runtime overhead and is considered an anti-pattern on Bluebird's website.

On a side note, I personally had success with the first option while encountering challenges with the second one.

Answer 3

Answer №2

Bluebird does not have a [Symbol.toStringTag], making it incompatible. Bluebird's implementation differs from native Promise in areas such as scheduler and error handling. To handle this properly:

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

If runtime compatibility is not an issue, you can address this with type casting in a 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 4

Bluebird does not have a [Symbol.toStringTag], making it incompatible. Bluebird's implementation differs from native Promise in areas such as scheduler and error handling. To handle this properly:

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

If runtime compatibility is not an issue, you can address this with type casting in a 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 5

Answer №3

In order to prevent encountering this issue, I make sure to include the async keyword in the function that is responsible for returning a promise using Bluebird.

For instance:

async myAsyncFunction(items){
   return Bluebird.map( items, (item) => {
      ...
   })
}

Answer 6

In order to prevent encountering this issue, I make sure to include the async keyword in the function that is responsible for returning a promise using Bluebird.

For instance:

async myAsyncFunction(items){
   return Bluebird.map( items, (item) => {
      ...
   })
}

"The Power of ES6 Promises in TypeScript and Harnessing the Strength of Bluebird Prom

Answer №1

Answer №2

Answer №3

Similar questions

Using Express and Node.js to encode an image file as base64 data

I am currently in the process of cross-referencing the tags that have been retrieved with those that have been selected or created. If a tag does not exist

Is Your Website Optimized for All Devices?

Employing ng-style for establishing background when the value does not align

Analyzing the differences in environment management between express and dotenv

Extract and loop through JSON data containing various headers

How does the order of objects in an array change when using *ngFor in Angular with a .subscribe() method in Ionic 3?

The loop does not seem to be cycling through every item in the JSON dataset

Prevent AngularJS from automatically inserting slashes in front of every single and double quote

Using ng-repeat to bind checkboxes to an object

Having trouble calculating the number of days between two dates at this moment

ExpressJS and NodeJS: Troubleshooting jQuery Integration Issues

Upload the PDF file along with other form data in a React application

What measures can I take to block their access to a specific location?

React: The value selected in the <select> dropdown was passed as an [object Object]

A router that has numerous parameters will not function properly with express.static

Sending information from one ajax request to anotherORTransferring

In Angular components, data cannot be updated without refreshing the page when using setInterval()

Navigating the realm of JavaScript and managing the uncertainties of floating point precision

Issue TS2305: The module "tls" does not have a member called 'TLSSocketOptions' available for export