TypeScript の型定義ファイルがなかったので自前で作ってみた時のメモ

MagicEye.js というステレオグラムが簡単に作成できるライブラリを TypeScript でも使えるようにしたくていろいろやったことのメモ。

とりあえずフォークする

npm は Github に置いているパッケージもインストールできるみたいなので、ひとまずフォークして自分のところで作業したものを npm でインストールすることにした。

型定義ファイルを追加

index.d.ts を追加して package.json の types にパスを指定してあげればパッケージに型定義ファイルを追加できるみたいなので、その辺りを追記。

export interface Options {
   // ...
}
export function render(options: Options): void

{
    ...
    "types": "types/index.d.ts",
    ...
}

フォークしたところからインストール

以下のコマンドでフォークしたところから npm でインストールする。
型定義ファイルが上手く指定できていればこれで使えるはず。

npm install git+[フォークしたリポジトリのURL]

その後

結局 HTML の Canvas 依存だったのと、記述がかなり古かったので
Node.js でも使えるようにリファクタしたものを一から作ることにした。

hayabusabusa/magicgram