ts An async function or method in ES5/ES3 requires the 'Promise' constructor

Question

Hello I'm Using async/await in my TypeScript Project, But I Get this log:

[ts] An async function or method in ES5/ES3 requires the 'Promise' constructor. Make sure you have a declaration for the 'Promise' constructor or include 'ES2015' in your --lib option.

How Can I Solve That?

unional · Accepted Answer · 2019-01-27T06:25:31.300

218

As the error message says, add lib: es2015 to your tsconfig.json

// tsconfig.json
{
  "compilerOptions": {
    "lib": [ "es2015" ]
  }
}

UPDATE: if this doesn't work for you, try this:

JetBrains IDE such as WebStorm, use its own implementation by default. Make sure you configure it to use TypeScript language service instead.

For Visual Studio, the project files and tsconfig.json are mutually exclusive. You will need to configure your project directly.

https://github.com/Microsoft/TypeScript/issues/3983#issuecomment-123861491

edited Jan 27 '19 at 06:25

answered Apr 22 '17 at 05:11

unional

14,651
5
32
56

`{ "compilerOptions": { "module": "commonjs", "target": "es5", "noImplicitAny": false, "sourceMap": false } }` this is my tsconfig.json How Should I edit? – Saeed Heidarizarei Apr 22 '17 at 05:14
Where to specify this in Visual Studio 2017? It does not have tsconfig.json – Akash Kava Aug 19 '17 at 08:50
@AkashKava You've to create `tsconfig.json` by your self. – katopz Aug 21 '17 at 04:29
1

@katopz I did, but VS does not care about it, I found that `csproj` file has some extra xml elements to enable/disable such things. – Akash Kava Aug 21 '17 at 06:57
4

I had to restart my IDE (WebStorm) to see the result. – ThCollignon Aug 27 '18 at 11:31
2

I have that ("lib": ["dom", "es2015"]) but it still complains – MJB Sep 07 '18 at 10:01
Are you using visual studio? It have a different way to setup. Not in tsconfig.json – unional Sep 08 '18 at 05:30
For webstorm, check your setting to make sure it uses TypeScript language service. – unional Sep 15 '18 at 05:22
The issue for me was that I also needed to update the "include" path. (See [https://stackoverflow.com/questions/46848802/webstorm-an-async-function-or-method-in-es5-es3-requires-the-promise-construc?rq=1](https://stackoverflow.com/questions/46848802) – brenzy Oct 21 '18 at 19:59
7

I had to include ``"dom"`` in the ``"lib"`` array as well or I get other errors. – derpedy-doo Mar 21 '19 at 05:45
For vscode IDE. If your tsconfig is correct make sure it is resolved and not falling back to defaults. – Filip Seman Nov 13 '21 at 14:23

score 32 · Answer 2 · answered Nov 27 '17 at 18:32

32

Try this package which contains type definitions for es6-promise

npm install --save @types/es6-promise

answered Nov 27 '17 at 18:32

Jeff Hernandez

2,063
16
20

2

If your target is node, `npm i -D @types/node@16` works too. – arve0 Feb 03 '22 at 09:48

score 15 · Answer 3 · edited Mar 14 '19 at 19:45

15

If you are on VS, delete the tsconfig.json and right click the project in Solution Explorer, then click on Properties->TypeScript Build in General change the followings

ECMAScript version: ECMAScript 6
Module System: ES2015

edited Mar 14 '19 at 19:45

Conspicuous Compiler

6,403
1
40
52

answered Feb 25 '18 at 17:20

Ivandro Jao

2,731
5
24
23

@LukePighetti project in solution-explorer – Ivandro Jao Nov 29 '18 at 14:36

score 7 · Answer 4 · answered Jul 09 '21 at 14:50

7

In my case, I had simply accidentally deleted my "return" statement in the function, and this error was showing until I put it back.

answered Jul 09 '21 at 14:50

raterus

1,980
20
23

That was exactly my case! Tried everything before noticing that. Thanks! – Matheus Oliveira Damião Jul 28 '23 at 19:57

bene-we · Answer 5 · 2020-05-20T08:33:46.623

6

For me the error occurred in my testing files inside src/tests folder. Since I use ts-node for testing the .ts files directly, I excluded src/tests/* in my tsconfig.json. As soon as I deleted the line the error was gone (which makes sense in the end).

Just in case someone else is struggling with this in his testing files.

EDIT: Of course you need to configure your --lib option correctly as outlined in the accepted answer. My tsconfig.json --lib option works as following:

"lib": [
    "es2018",
    "dom"
]

edited May 20 '20 at 08:33

answered May 20 '20 at 08:28

bene-we

761
11
23

I compile with `tsc` an async function in a ts file on the client, not on the server. I use `document.getElementById` in the function. When using `dom` with `--lib` as param to `tsc` it works. So I think `dom` is needed if you are on the client. – Timo Dec 27 '22 at 15:19

score 4 · Answer 6 · answered Jun 07 '21 at 03:32

Add "es2015.promise" in tsconfig.json - in "lib" = like this :

{
    "compilerOptions": {
        "target": "es5",
        "lib": [
            "es5",
            "dom",
            "es2015.promise"
        ],
        "types": [
            "mocha"
        ],
        "module": "commonjs",
        "outDir": "../../../out",
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true,
        "sourceMap": true,
        "declaration": true
    },
    "exclude": [
        "node_modules",
        "dist",
        "tests"
    ]
}

score 2 · Answer 7 · answered Mar 12 '19 at 01:03

2

You could also use the "lib": "es2015.promise" for that specific error

answered Mar 12 '19 at 01:03

Rannie Aguilar Peralta

1,566
14
19

score 2 · Answer 8 · answered Sep 30 '19 at 21:24

VS2019 does not seem to recognize the tsconfig.json file, so LIB options will not change the application. This is a way to add the PROMISE for typescript to accept ASYNC AWAIT.

export function AD(first: any, second: any, callBack: any)
{
    const rtn = async (dispatch: any): Promise<void> =>
    {
        await axios.post(TYPE.URI, { // provide a string of a URI to post into
            parm1: first,
            parm2: second
        })
            .then(data => // or you can use response instead of data as a name
            {
                console.log("data from call next");
                console.log(data);
                dispatch({ type: TYPES.AD, payload: data.data });
                if (callBack)
                {
                    callBack(data);
                }
            })
    }
    return rtn;

}

score 1 · Answer 9 · answered May 06 '21 at 17:56

1

tsc --target ES6

This was the solution for me !

answered May 06 '21 at 17:56

rambi

1,013
1
7
25

this helped with WebStorm! – Roman May 26 '23 at 16:37

ALbert2504 · Answer 10 · 2021-12-20T06:53:25.307

1

When you compile or watch your typescript file via tsc index.ts --watch add --lib flag to it with its value (in our case es2015), it should look like this
tsc index.ts --watch --lib es2015
for better work tsc index.ts --watch --lib "es2015, es2016, dom" - when it can't read dom from tsconfig.json

edited Dec 20 '21 at 06:53

answered Dec 19 '21 at 17:34

ALbert2504

11
2

score 0 · Answer 11 · answered Aug 14 '20 at 19:16

I've finally managed to solve it!
My command on the terminal: yarn tsc main.ts && nodejs main.js My error message:

main.ts:1:16 - error TS2705: An async function or method in ES5/ES3 requires the 'Promise' constructor.  Make sure you have a declaration for the 'Promise' constructor or include 'ES2015' in your `--lib` option.

1 async function main() {
                 ~~~~


Found 2 errors.

error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

What I did to solve it, was referencing the tsconfig.json file.
My tsconfig.json file was like this:

{
    "compilerOptions": {
        "target": "ESNext",
        "lib": [
            "ES2015",
            "DOM"
        ]
    }
}

And my terminal command is like this: yarn tsc -p ./tsconfig.json && nodejs main.js If I want to run other .ts file I simply do: yarn tsc -p ./tsconfig.json && nodejs file_name.js

score 0 · Answer 12 · answered Jun 01 '22 at 11:11

In addition to the other responses which suggest adding the lib as follows

...
"lib": ["es2015"],
...

the typescript server must also be restarted.

On Visual Studio Code you can do it using the command-palette option (default is CTRL + Shift + P on Windows) and searching for Restart TS Server

score 0 · Answer 13 · answered Oct 24 '22 at 01:54

I am using JetBrains Rider 2022.2.3 and had the following in my .csproj project file (I am not using the tsconfig.json file):

  <PropertyGroup>
    <TypeScriptTarget>ES6</TypeScriptTarget>    
  </PropertyGroup>

The above meant that I could compile my TypeScript just fine, but Rider was still showing same "use --lib option" error message until I set the target to ES6 for TypeScript Language Service as well. Do it as follows in settings:

Valone · Answer 14 · 2018-09-25T16:12:21.987

-3

I am using VS2017 v15.8.2 and Typescript 2.4.2 in an Angular 4 project (under a class library project in my solution, not a typescript project). I was able to remove the error/warning in VS by disabling the JavaScript language service:

Options => Text Editor => JavaScript/TypeScript => Language Service

Restart VS.

Hope this helps.

edited Sep 25 '18 at 16:12

answered Jul 25 '18 at 15:54

Valone

41
7

ts An async function or method in ES5/ES3 requires the 'Promise' constructor

14 Answers14

Linked