[Node]TypeScriptでprocessオブジェクトに新しくKey, Valueを追加する場合の型定義に関して

Question

聞きたいこと

JavaScriptで書かれたコードをTypeScriptに移行している際に、下のようなエラーに遭遇しました。

• エラー

TS2339: Property '__API__' does not exist on type 'Process'.

• 実際のソースコード

import * as firebase from 'firebase/app';
import 'firebase/database';

export default function createAPI({ config, version }) {
  let api;
  if (process.__API__) {
    api = process.__API__;
  } else {
    firebase.initializeApp(config);
    api = process.__API__ = firebase.database().ref(version);
    api.onServer = true;
  }
  return api;
}

Nodeのprocessオブジェクトに __API__ が存在していないために出ているエラーであることはわかるので、
型定義を追加して、 __API__ を受け付けられるようにすればいいと思うのですが、 Nodeで標準で提供されているオブジェクトに型定義を追加する方法ってあるのでしょうか？

Comments

[maisumakun]

どのような目的で、processにプロパティを追加しているのでしょうか？

Answer 1

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/process.d.ts#L174
おそらく@types/nodeの型定義を利用していると思いますが、 process の型である Process はこちらで定義されているので、これをインターフェイス拡張すれば求めていることはできると思います。

declare global {
  namespace NodeJS {
    interface Process {
        __API__: any;
    }
  }
}

ただ、そもそもグローバルオブジェクトを拡張するというのが設計として良くない気がしますね。（気になったので調べてみたらこんな記事が出てきましたがこのやり方が何由来のものなのかは分からなかった）
普通はグローバルオブジェクトの定義なんて行わずに、モジュール内で定義してそれをimportするだけで良いはずです。どうしてもこのやり方を維持しなければいけない明確な理由があるのでなければ、私ならやり方を変えるかなと思います。一時的にコンパイルが通るようにするためにこういう小手先の誤魔化しはするかもしれませんが。

Comments

[maisumakun]

「ブラウザ内で別々に読み込んだスクリプト同士の連携のために、window経由で参照する」など、必要悪としてプロパティ追加を使う場面もありますね…

[kazatsuyu]

その場合は、「そもそも何で別々に読み込まれているんだ」というところから検討の対象にしますね。もちろん検討の結果、やり方を変えるコストや工数が大きいので諦めるとか、ブラウザ拡張をインストールすることで使えるようになる機能があるので分けざるを得ないとかそういう場合もありますが、そういうケースは「どうしてもこのやり方を維持しなければいけない明確な理由」に該当すると思います

[kazatsuyu]

s/コスト/リスク/