logo标签列表

如何在 TypeScript 中使用顶级 async/await？

node.jstypescript
31

我有一个 TypeScript 项目，当我在顶层使用 await xxx.someAsyncMethod(..) 时，TypeScript linter 显示：

Top-level 'await' expressions are only allowed when the 'module' option is set to 'esnext' or 'system', and the 'target' option is set to 'es2017' or higher.

所以我将把模块更改为esnext "module": "esnext"

然后我将尝试运行程序npx ts-node app/app.ts

然后控制台告诉我

(node:15509) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
Cannot use import statement outside a module

在package.json中将type设置为module "type": "module"，当我运行程序时控制台会输出

TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /Users/apple/Desktop/source_given_to_me/Git/bots/wab/app/app.ts
    at Loader.defaultGetFormat [as _getFormat] (internal/modules/esm/get_format.js:65:15)
    at Loader.getFormat (internal/modules/esm/loader.js:113:42)
    at Loader.getModuleJob (internal/modules/esm/loader.js:244:31)
    at Loader.import (internal/modules/esm/loader.js:178:17)

我如何才能使用顶层的 async/await？

编辑: 我的 redis.ts 文件


import * as pm from "child_process"
var prc:pm.ChildProcess;

async function startRedis(path:string): Promise<boolean> {
    return new Promise((resolve) => {
        console.log('starting redis')
        var rp = pm.spawn(path)
        rp.stdout.on("data", (data) => {
            console.log(data)
            console.log('redis fired up')
            prc= rp
            resolve(true)
        })
        rp.stderr.on("data", (data) => {
            console.log(data)
            console.log('redis failed to start')
            resolve(false)
        })
    })
}

function active():boolean{
    return prc?!prc.killed:false
}

async function stopRedis(): Promise<boolean> {
    return new Promise(
        (resolve)=>{
            if(prc){
                resolve(prc.kill("SIGTERM"))
            } else {
                resolve(false)
            }
        }
    )
}


export const redis = {
    startRedis,
    stopRedis,
    active
}

我的 config.ts 文件（tsconfig.json 如下）

export const config = {
    redisPath:'../r607/src/redis-server'
}

我的 app.ts 文件

import {config} from "./config.js"
import {redis} from "./redis.js"
//import * as pm from "child_process"

await redis.startRedis(config.redisPath)
if(!redis.active()){
    process.abort()
}

我的tsconfig.json

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "esnext",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "ESNext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
     "outDir": "./build",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}
1
也许这可以帮助你：https://github.com/TypeStrong/ts-node/issues/1007。特别是这部分：“*符合习惯的 TypeScript 应该将 foo.ts 导入为 import 'foo.js';，TypeScript 可以理解这一点。”* - Felix Kling
你能把你的代码和 tsconfig.json 文件复制粘贴一下吗？ - Sohan
2
解决这种问题的简单方法是在主文件中使用异步IIFE，并在其中执行所有异步操作。例如：(async boot() { await foo(); })() - Marek Urbanowicz
@MarekUrbanowicz 是的，那是我现在正在使用的，谢谢。 - Yadu
@FelixKling 我尝试过了，但没有成功。 - Yadu
3个回答
13
请按照以下步骤操作：
  • 在 package.json 中添加 "type": "module"。
  • 将 package.json 中的 "main": "index.js" 替换为 "exports": "./index.js"。
  • 将 package.json 中的 "engines" 字段更新为 Node.js 12："node": "^12.20.0 || ^14.13.1 || >=16.0.0"。
  • 在 tsconfig.json 中添加 "module": "ES2020"。
  • 仅使用完整的相对文件路径进行导入：import x from '.'; → import x from './index.js';。
  • 删除 namespace 的使用，改用 export。
  • 可选但建议，使用node: 协议 进行导入。
  • 即使您正在导入 .ts 文件，相对导入也必须使用 .js 扩展名。

如果使用 ts-node，请像这样使用：

node --loader ts-node/esm ./entrypoint.ts

编辑： 源代码Gist

6
这看起来与 https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c 非常相似。你是否忘记了给初版作者署名？ - nulltoken
1
除了被复制外，这个答案还省略了任何上下文。更好的信息可以在这里找到：https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#top-level-await - Mark
谢谢。仅添加这个内容对我有效：在你的 package.json 文件中添加 "type": "module"。 - dragon
10

您可以使用这种模式来实现相同的结果：

async function main(): Promise<void> {
    const foo = await somePromise
    console.log(foo)
}

main()

即使你没有在 main 函数中使用 await，NodeJS 仍然不会退出直到事件队列为空。换句话说，在有未解决的 Promise 的情况下，它不会退出。

11
问题是“如何在 TypeScript 中使用顶级异步等待（top level async await）？”。这不是对问题的回答。 - mikemaccana
2
@mikemaccana 但这仍然是一个不错的解决方法。点赞它。 - aristotll
1
@aristotll 不是这样的。如果你需要等待 main() 并在它之后做更多的事情呢？ - Devin
@Devin 在这种情况下，main不是主函数 :) 你应该给它取一个不同的名字，然后这样做 async function main() { await myRenamedFunction(); doMoreStuff(); } - Matthew
0
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接