TypeScriptのd.tsでCommonJSスタイルのエクスポートの型を記述する際に引っかかったこと
CommonJS対応プルリク
https://bitbucket.org/atlassian/atlassian-connect-express/pull-requests/254
https://bitbucket.org/atlassian/atlassian-connect-express/pull-requests/257
d.tsコードの全貌
type BearerToken = {
access_token: string;
};
declare class AddOn {}
declare class HostClient {
getUserBearerToken: (scopes: string[], clientSettings: AddOnFactory.ClientInfo) => Promise<BearerToken>;
}
declare function AddOnFactory(): AddOn;
declare namespace AddOnFactory {
export type HostClient = InstanceType<typeof HostClient>;
export interface ClientInfo {
key: string
}
export type AddOn = InstanceType<typeof AddOn>;
export type AddOnFactory = typeof AddOnFactory;
export { BearerToken };
}
export = AddOnFactory;
使い方
esModuleInterop
がfalse
でも動きます。
import ace = require('atlassian-connect-express');
import { HostClient, ClientInfo, AddOn, AddOnFactory, BearerToken } from 'atlassian-connect-express';
説明
今回求められたのは、module.exports
で関数をエクスポートしつつ、名前付きエクスポートで型をエクスポートすることです。
これを実現するためには、function
とnamespace
を同名で宣言して、export = AddOnFactory
構文でエクスポートする必要があります。
また、エクスポートするインターフェースはnamespace
内で宣言すると何回も別名を定義する必要がなく、簡潔です。
typeof AddOnFactory
はtypeof
付けないと循環参照になってエラーになります。
最後に、typeof HostClient
と書くと型が"function"
になってしまうのでInstanceType<typeof HostClient>
と書く必要があります。
これ知らなくて知らない人から怒られました
Author And Source
この問題について(TypeScriptのd.tsでCommonJSスタイルのエクスポートの型を記述する際に引っかかったこと), 我々は、より多くの情報をここで見つけました https://qiita.com/umireon/items/694189ed3ecf02429f64著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .