st-func-ts

st-func-tsは建築構造設計で役立つ関数を集めたTypeScript用ライブラリです。

概要

例えば組立H形鋼の寸法から断面積を計算するための関数等、

建築構造設計で役立つ関数を集めたTypeScript用のライブラリです。

現在開発中のため、使える関数は少ないですが、少しずつ増やしていく予定です。

利用方法

まだnpmに公開はしていません。

利用する場合は、手作業でインストールする必要があります。

インストール方法、関数の仕様については、マニュアル(作成中)を参照ください。

免責事項

製作者は、このライブラリの使用に関連して発生したいかなる損害についても一切の責任を負いません。 バグなどで計算結果が正しくない可能性もありますので、自己責任での利用をお願いしまします。

開発について

関数や機能の追加要望についてはご連絡ください。

また、こちらのライブラリはオープンソースとしています。

ソースコードを直接編集して、Pull requestしていただくことも歓迎です。

開発の方針

• 関数にはできるだけTSDocでコメントをつける
• 数値計算の関数は必ずtestを作成する
  • テストコードは*.test.tsに記載
• 数値計算が主であることから、型付けがしっかりしているTypeScriptで記述する
• 関数名などの単語はST-Bridgeを参考にする

Branchの説明

mainブランチ

mainブランチは通常方法でライブラリをインストールしたときにロードされるコードです。

mainブランチはdevelopブランチからのマージのみ実施するため、Pull request等はしないでください。

developブランチ

developブランチは開発中の最新のコードです。

forkやPull requestはこちらのブランチを利用してください。

お問い合わせ

st_func@outlook.jp までご連絡ください。