TypeScript定義ファイルを使ったnjsコードの書き方

TypeScript 定義ファイルのコンパイル API のチェックとオートコンプリート njs type-safe コードの書き方

TypeScript は、単純なJavaScriptにコンパイルされるJavaScriptの型付きスーパーセットです。

TypeScript は、既存のJavaScriptライブラリの型情報を含む定義ファイルをサポートします。これにより、他のプログラムは、静的な型指定されたTypeScriptエンティティであるかのように、ファイルで定義された値を使うことができます。

njs は、API 用のTypeScript定義ファイルを提供し、以下の目的で使えます:

• エディタでオートコンプリートとAPIチェックをする
• njs type-safe コードの書き方

TypeScript定義ファイルのコンパイル

$ hg clone http://hg.nginx.org/njs
$ cd njs && ./configure && make ts
$ ls build/ts/
njs_core.d.ts
njs_shell.d.ts
ngx_http_js_module.d.ts
ngx_stream_js_module.d.ts

APIチェックとオートコンプリート

*.d.ts ファイルを、エディタが見つけられる場所に置きます。

test.js:

/// <reference path="ngx_http_js_module.d.ts" />
/**
 * @param {NginxHTTPRequest} r
 * */
function content_handler(r) {
    r.headersOut['content-type'] = 'text/plain';
    r.return(200, "Hello");
}

njs type-safe コードの書き方

test.ts:

/// <reference path="ngx_http_js_module.d.ts" />
function content_handler(r: NginxHTTPRequest) {
    r.headersOut['content-type'] = 'text/plain';
    r.return(200, "Hello from TypeScript");
}

TypeScript のインストール:

# npm install -g typescript

TypeScriptのコンパイル:

$ tsc test.ts
$ cat test.js

結果のtest.jsファイルは、njsで直接使うことができます。