serverlessのserverless.yml
から*.d.ts
を生成するプログラムです。
- Releasesからダウンロードします。
- 一番上にあるバージョンを見ます。
<プラットフォーム>
は以下のとおりです。- Windows: x86_64-pc-windows-gnu
- Linux: unknown-linux-musl
- macOS: x86_64-apple-darwin
<拡張子>
は次のとおりです。- Windows:
zip
- Linux:
tar.gz
またはtar.xz
- macOS:
zip
- Windows:
serverless-dts-generator_<バージョン>_<プラットフォーム>.<拡張子>
とserverless-dts-generator_<バージョン>_<プラットフォーム>.<拡張子>.sha256sum
をダウンロードします。- (推奨) ハッシュ値を検証します。
serverless-dts-generator_<バージョン>_<プラットフォーム>.<拡張子>
を展開します。- 使用を開始するためには、コマンドラインへ移動します。
Windows:
- Win + Rキーを押して、
powershell
と入力し、Enterを押します。 - 次のコマンドをコピーアンドペーストしてEnterを押します。
$archive_file = "kisaragi-booth-utility_0.1.1_x86_64-pc-windows-gnu.zip"
$hash_file = $archive_file + ".sha256sum"
$actual_hash = if ($PSVersionTable.PSCompatibleVersions -contains [System.Version]::New(4, 0)) {
$hash_obj = Get-FileHash $archive_file -Algorithm SHA256
$hash_obj.Hash.ToLower() + " " + $(Split-Path $hash_obj.Path -leaf)
} else {
# Get-FileHash is unsupported
$hasher = [System.Security.Cryptography.SHA256]::Create()
$io = New-Object System.IO.StreamReader $archive_file
$hash_arr = $hasher.ComputeHash($io.BaseStream)
$stream.Close()
$hash = ""
$hash_arr | %{ $hash += $_.ToString("x2") }
$hash
}
$expected_hash = (type $hash_file) -join ""
if ($actual_hash -eq $expected_hash) {
Write-Host "Hash OK"
} else {
Write-Error "Hash Error: '$actual_hash' != '$expected_hash'"
}
Hash OK
と表示された場合、検証が完了しています。
Linux/macOS:
- お好みのPOSIX互換シェルを開きます。
- 次のコードをコピーアンドペーストして実行します。macOSでは
sha256sum
をgsha256sum
に変える必要があります。
#!/bin/sh
actual_hash=$(sha256sum kisaragi-booth-utility_0.1.1_x86_64-unknown-linux-musl.tar.gz)
expected_hash=$(cat kisaragi-booth-utility_0.1.1_x86_64-unknown-linux-musl.tar.gz.sha256sum)
if [ "$original_hash" -eq "$expected_hash" ]; then
echo "Hash OK"
else
echo "Hash Error: '$actual_hash' != '$expected_hash'" >&2
fi
Hash OK
と表示された場合、検証が完了しています。
serverless-dts-generator [serverless.ymlのパス]
[serverless.ymlのパス]
-serverless.yml
のパスを指定します。
*.d.ts
はserverless.yml
などのスキーマに設定されたパスに応じて生成される場所が変わります。具体的には、handler
プロパティに設定されたパスと同じディレクトリに、ファイル名と同名の.d.ts
が生成されます。- 例:
handler
プロパティにsrc/hoge/piyo.createPiyo
が設定されている場合、createPiyo
という名前のdeclare const
を生成し、src/hoge/piyo.d.ts
にそれを書き込みます。
- 例:
- 今の所、基本的なHTTPリクエストに対するサポートしかありません。
- その他の
event
がある場合は、ごく弱い型しかつきません。
- その他の
- 複数の
event
はサポートしていません。- 最初の
event
だけが考慮され、他のイベントは暗黙に無視されます。
- 最初の
Apache License, Version 2.0とMITライセンスのデュアルライセンスです。どちらかのライセンスを選択することができます。
各ライセンス文はそれぞれLICENSE-Apache-2.0.txtとLICENSE-MIT.txtに同梱してあります。