类初始化执行异步代码时,如何正确赋值类属性并解决TS、ESLint报错
TypeScript 异步类初始化报错解决方案
分问题对应处理方式
1. 类字段TypeScript报错处理
两类常见报错的适配方案:
TS2339: Property 'xxx' does not exist on type 'XxxClass':未在类顶层声明对应字段的类型,补充字段声明即可解决。TS2564: Property 'xxx' has no initializer and is not definitely assigned in the constructor.:使用TypeScript官方提供的确定赋值断言(!),在字段声明末尾追加该符号,告知编译器该字段会在类生命周期内完成合法赋值,无需校验构造函数内的初始化逻辑。
字段声明示例:
// 报错写法 auth: AuthAPI; // 修复写法 auth!: AuthAPI;
可选替代方案:若不使用确定赋值断言,可将字段声明为可选类型(auth?: AuthAPI),但访问属性时需要额外做空值判断,适合异步字段可能不存在的场景。
2. 空构造函数ESLint报错处理
ESLint: Unexpected empty constructor.通常来自ESLint的no-empty-function/no-empty规则,两种合规处理方式:
- 若构造函数为private(用于限制外部直接实例化、仅通过静态工厂创建实例):在空构造函数体内补充说明性注释,即可绕开规则的空函数判定:
// 报错写法 private constructor() {} // 修复写法 private constructor() { /* 私有构造仅用于静态工厂初始化,无同步初始化逻辑 */ }
- 若无需限制外部直接实例化:直接删除显式构造函数,JS会自动生成默认的隐式空构造函数,ESLint不会对隐式生成的构造函数触发空函数报错。
3. 异步初始化属性正常访问保障
核心逻辑是确保异步工厂/init方法返回的实例类型为完整初始化完成的类类型:
- 静态工厂函数方案:明确标注返回值为
Promise<当前类名>,配合上述字段确定赋值断言,await拿到的实例会完整包含所有异步初始化的属性类型,可直接调用无报错。 - init方法方案:将init方法的返回值标注为
Promise<当前类名>,同时配合字段确定赋值断言,避免访问属性时的类型报错。
init方法适配示例:
class MyClass { property!: SomeType; // 确定赋值断言解决TS2564 constructor() { /* 无同步初始化逻辑,加注释避免ESLint报错 */ } async init(someParameter: ParamType): Promise<MyClass> { this.property = await something(someParameter); return this; } } // 调用方式 const myClass = await new MyClass().init(x, y); myClass.property; // 无类型报错
业务场景修正后代码示例
class Api { // 字段追加确定赋值断言,解决TS2564报错 auth!: AuthAPI; checkout!: CheckoutAPI; cart!: CartAPI; categories!: CategoriesAPI; collections!: CollectionsAPI; products!: ProductsAPI; // 构造函数加注释,解决ESLint空构造报错 private constructor() { /* 私有构造仅用于静态工厂初始化,无同步初始化逻辑 */ } static async create( client: ApolloClient<any>, config: ConfigInput, onStateUpdate?: () => any, ): Promise<Api> { const api = new Api(); const finalConfig = { ...defaultConfig, ...config }; const localStorageHandler = new LocalStorageHandler(); const apolloClientManager = new ApolloClientManager(client); const jobsManager = await JobsManager.create(localStorageHandler, apolloClientManager); const saleorState = await SaleorState.create(finalConfig, localStorageHandler, apolloClientManager, jobsManager); const localStorageManager = new LocalStorageManager(localStorageHandler, saleorState); if (onStateUpdate) { saleorState.subscribeToNotifiedChanges(onStateUpdate); } // 异步逻辑初始化属性 api.auth = new AuthAPI(saleorState, jobsManager, finalConfig); api.checkout = new SaleorCheckoutAPI(saleorState, jobsManager); api.cart = new SaleorCartAPI(localStorageManager, apolloClientManager, saleorState, jobsManager); api.categories = new CategoriesAPI(client); api.collections = new CollectionsAPI(client); api.products = new ProductsAPI(client); return api; } } // 调用示例(修正原代码create拼写错误) const myApi = await Api.create(apolloClient, config, onSaleorApiChange); const auth = myApi.auth; // 无类型报错
内容的提问来源于stack exchange,提问作者Cristian Flórez
相关产品推荐
相关产品推荐

