How to use Typescript with native ES6 Promises

javascript typescript es6-promise
dchang picture dchang · Dec 19, 2014 · Viewed 128.5k times · Source

I'm a complete beginner to Typescript and am wondering if it's possible to use ES6 promises in Typescript and what I would have to do to get them to work. I'm running node 0.11.14 and am getting an error during compilation "Cannot find name 'Promise'"

Answer

Dick van den Brink picture Dick van den Brink · Dec 19, 2014

The current lib.d.ts doesn't have promises in it defined so you need a extra definition file for it that is why you are getting compilation errors.

You could for example use (like @elclanrs says) use the es6-promise package with the definition file from DefinitelyTyped: es6-promise definition

You can then use it like this:

var p = new Promise<string>((resolve, reject) => { 
    resolve('a string'); 
});

edit You can use it without a definition when targeting ES6 (with the TypeScript compiler) - Note you still require the Promise to exists in the runtime ofcourse (so it won't work in old browsers :)) Add/Edit the following to your tsconfig.json :

"compilerOptions": {
    "target": "ES6"
}

edit 2 When TypeScript 2.0 will come out things will change a bit (though above still works) but definition files can be installed directly with npm like below:

npm install --save @types/es6-promise - source

edit3 Updating answer with more info for using the types.

Create a package.json file with only { } as the content (if you don't have a package.json already. Call npm install --save @types/es6-promise and tsc --init. The first npm install command will change your package.json to include the es6-promise as a dependency. tsc --init will create a tsconfig.json file for you.

You can now use the promise in your typescript file var x: Promise<any>;. Execute tsc -p . to compile your project. You should have no errors.

Related questions

How to reject in async/await syntax?

How can I reject a promise that returned by an async/await function? e.g. Originally: foo(id: string): Promise<A> { return new Promise((resolve, reject) => { someAsyncPromise().then((value)=>resolve(200)).catch((err)=>reject(400)) }); } Translate into …

Read More
Typescript returning boolean after promise resolved

I'm trying to return a boolean after a promise resolves but typescript gives an error saying A 'get' accessor must return a value. my code looks like. get tokenValid(): boolean { // Check if current time is past access token's expiration this.…

Read More
Does a async function which returns Promise<void> have an implicit return at the end of a block?

public async demo(): Promise<void> { // Do some stuff here // Doing more stuff // ... // End of block without return; } Is a new Promise<void> returned implicitely at the end of the block in TypeScript/ES6? Example for boolean …

Read More