@theerapat-s28/ts-structural-eng-tools 1.2.0 โ 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -1
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
1
|
# ts-structural-eng
|
|
2
2
|
|
|
3
|
+
**๐ [API Reference โ theerapat-s28.github.io/ts-structural-eng](https://theerapat-s28.github.io/ts-structural-eng/)**
|
|
4
|
+
|
|
3
5
|
A TypeScript library of structural-engineering helper functions and beam design utilities. Designed to be copied and reused across TypeScript frameworks.
|
|
4
6
|
|
|
7
|
+
## Documentation
|
|
8
|
+
|
|
9
|
+
Full API reference, with parameter tables, worked examples, warnings and error codes:
|
|
10
|
+
|
|
11
|
+
- **[API reference](https://theerapat-s28.github.io/ts-structural-eng/)** โ landing page
|
|
12
|
+
- [RC Beam Design](https://theerapat-s28.github.io/ts-structural-eng/rc/) โ `@theerapat-s28/ts-structural-eng-tools/rc`
|
|
13
|
+
- [Strengthening](https://theerapat-s28.github.io/ts-structural-eng/strengthening/) โ `@theerapat-s28/ts-structural-eng-tools/strengthening`
|
|
14
|
+
|
|
15
|
+
The pages are served from [`html-docs/`](https://github.com/theerapat-s28/ts-structural-eng/tree/main/html-docs) via GitHub Pages.
|
|
16
|
+
|
|
5
17
|
## Quick summary
|
|
6
18
|
|
|
7
|
-
- Package:
|
|
19
|
+
- Package: `@theerapat-s28/ts-structural-eng-tools`
|
|
8
20
|
- Entry: `src/index.ts`
|
|
9
21
|
- Build output: `dist/` (JS + `.d.ts` files)
|
|
10
22
|
|
|
@@ -15,6 +27,15 @@ A TypeScript library of structural-engineering helper functions and beam design
|
|
|
15
27
|
|
|
16
28
|
## Install
|
|
17
29
|
|
|
30
|
+
Use the published package:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pnpm add @theerapat-s28/ts-structural-eng-tools
|
|
34
|
+
# or: npm install @theerapat-s28/ts-structural-eng-tools
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Or install this repository's dependencies to work on the library itself:
|
|
38
|
+
|
|
18
39
|
```bash
|
|
19
40
|
pnpm install
|
|
20
41
|
```
|
|
@@ -60,6 +81,11 @@ tests/
|
|
|
60
81
|
โโโ rc/ # Tests for RC module
|
|
61
82
|
โโโ strengthening/ # Tests for strengthening module
|
|
62
83
|
โโโ utils/ # Tests for utilities
|
|
84
|
+
html-docs/ # HTML API reference, deployed to GitHub Pages
|
|
85
|
+
โโโ DESIGN.md # Style guide for the doc pages
|
|
86
|
+
โโโ index.html # Landing page
|
|
87
|
+
โโโ rc/index.html
|
|
88
|
+
โโโ strengthening/index.html
|
|
63
89
|
```
|
|
64
90
|
|
|
65
91
|
## TypeScript path aliases
|
|
@@ -80,6 +106,8 @@ For runtime resolution, `tsconfig-paths` is registered in the `dev` script.
|
|
|
80
106
|
|
|
81
107
|
## API
|
|
82
108
|
|
|
109
|
+
Summarised below; see the [full API reference](https://theerapat-s28.github.io/ts-structural-eng/) for parameter tables, units, warnings and error codes.
|
|
110
|
+
|
|
83
111
|
### RC Beam Design
|
|
84
112
|
|
|
85
113
|
- **`rectBeamMomentCapacity(section)`** โ Computes ฯMn for a rectangular RC beam (singly or doubly reinforced). Returns `phiMn` in kNยทm with calculation details and ACI 318-19 warnings.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@theerapat-s28/ts-structural-eng-tools",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "TypeScript structural-engineering helper functions and beam design utilities",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -42,9 +42,13 @@
|
|
|
42
42
|
],
|
|
43
43
|
"author": "",
|
|
44
44
|
"license": "ISC",
|
|
45
|
+
"homepage": "https://theerapat-s28.github.io/ts-structural-eng/",
|
|
45
46
|
"repository": {
|
|
46
47
|
"type": "git",
|
|
47
|
-
"url": ""
|
|
48
|
+
"url": "git+https://github.com/theerapat-s28/ts-structural-eng.git"
|
|
49
|
+
},
|
|
50
|
+
"bugs": {
|
|
51
|
+
"url": "https://github.com/theerapat-s28/ts-structural-eng/issues"
|
|
48
52
|
},
|
|
49
53
|
"publishConfig": {
|
|
50
54
|
"access": "public"
|