calc-vpd 1.0.0 → 2.0.0

package/lib/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcVpd = void 0;
+var vpd_js_1 = require("./vpd.js");
+Object.defineProperty(exports, "calcVpd", { enumerable: true, get: function () { return vpd_js_1.calcVpd; } });

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/cjs/vpd.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcVpd = void 0;
+const floor8 = (n) => Math.round(n * 10 ** 9) / 10 ** 9;
+/**
+ * VPD (Vapor Pressure Deficit / 飽差) を気温・相対湿度から求める。
+ *
+ * - 水蒸気圧 vp = 6.1078 * 10 ^ (7.5 * 気温 / (気温 + 237.3))
+ * - 飽和水蒸気量 swv = 217 * vp / (気温 + 273.15)
+ * - 飽差 vpd = (100 - 相対湿度) * swv / 100
+ */
+const calcVpd = (input) => {
+    const { tmp, hmd } = input ?? {};
+    if (typeof tmp !== 'number' || typeof hmd !== 'number') {
+        throw new TypeError(`Expected a { tmp: number, hmd: number }, got ${typeof tmp} ${typeof hmd}`);
+    }
+    const vp = floor8(6.1078 * 10 ** ((7.5 * tmp) / (tmp + 237.3)));
+    const swv = floor8((217 * vp) / (tmp + 273.15));
+    const vpd = floor8(((100 - hmd) * swv) / 100);
+    return { vp, swv, vpd };
+};
+exports.calcVpd = calcVpd;

package/lib/esm/index.js

@@ -0,0 +1 @@
+export { calcVpd } from './vpd.js';

package/lib/esm/vpd.js

@@ -0,0 +1,18 @@
+const floor8 = (n) => Math.round(n * 10 ** 9) / 10 ** 9;
+/**
+ * VPD (Vapor Pressure Deficit / 飽差) を気温・相対湿度から求める。
+ *
+ * - 水蒸気圧 vp = 6.1078 * 10 ^ (7.5 * 気温 / (気温 + 237.3))
+ * - 飽和水蒸気量 swv = 217 * vp / (気温 + 273.15)
+ * - 飽差 vpd = (100 - 相対湿度) * swv / 100
+ */
+export const calcVpd = (input) => {
+    const { tmp, hmd } = input ?? {};
+    if (typeof tmp !== 'number' || typeof hmd !== 'number') {
+        throw new TypeError(`Expected a { tmp: number, hmd: number }, got ${typeof tmp} ${typeof hmd}`);
+    }
+    const vp = floor8(6.1078 * 10 ** ((7.5 * tmp) / (tmp + 237.3)));
+    const swv = floor8((217 * vp) / (tmp + 273.15));
+    const vpd = floor8(((100 - hmd) * swv) / 100);
+    return { vp, swv, vpd };
+};

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { VpdInput, VpdResult } from './vpd.js';
+export { calcVpd } from './vpd.js';

package/lib/types/vpd.d.ts

@@ -0,0 +1,22 @@
+export type VpdInput = {
+    /** 気温 (℃) */
+    tmp: number;
+    /** 相対湿度 (%) */
+    hmd: number;
+};
+export type VpdResult = {
+    /** 水蒸気圧 */
+    vp: number;
+    /** 飽和水蒸気量 */
+    swv: number;
+    /** 飽差 (Vapor Pressure Deficit) */
+    vpd: number;
+};
+/**
+ * VPD (Vapor Pressure Deficit / 飽差) を気温・相対湿度から求める。
+ *
+ * - 水蒸気圧 vp = 6.1078 * 10 ^ (7.5 * 気温 / (気温 + 237.3))
+ * - 飽和水蒸気量 swv = 217 * vp / (気温 + 273.15)
+ * - 飽差 vpd = (100 - 相対湿度) * swv / 100
+ */
+export declare const calcVpd: (input: VpdInput) => VpdResult;

package/package.json

@@ -1,43 +1,54 @@
 {
   "name": "calc-vpd",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "VPD (Vapor Pressure Deficit) function",
   "license": "MIT",
   "repository": "elzup/calc-vpd",
   "author": "elzup",
-  "engines": {
-    "node": ">=14"
-  },
-  "scripts": {
-    "precommit": "lint-staged",
-    "fmt": "prettier --write '**/*.{js,json,md}'",
-    "lint": "eslint --ext .js .",
-    "test": "jest",
-    "test:cov": "jest --coverage --ci --runInBand",
-    "test:ci": "yarn lint && yarn test:cov",
-    "prepare": "husky install"
-  },
-  "lint-staged": {
-    "*.{js,json,md}": [
-      "prettier --write",
-      "git add"
-    ]
+  "type": "module",
+  "packageManager": "pnpm@10.26.2",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    }
   },
+  "sideEffects": false,
   "files": [
-    "index.js"
+    "lib"
   ],
   "keywords": [
     "vpd",
     "IoT",
     "aguri"
   ],
-  "dependencies": {},
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "pnpm clean && pnpm build:cjs && pnpm build:esm && pnpm build:types",
+    "build:cjs": "tsc --module commonjs --moduleResolution node10 --declaration false --outDir lib/cjs && echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json",
+    "build:esm": "tsc --module esnext --moduleResolution bundler --declaration false --outDir lib/esm",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir lib/types",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "fmt": "biome format --write .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:cov": "vitest run --coverage",
+    "prepare": "git config core.hooksPath .githooks || true",
+    "prepublishOnly": "pnpm build && pnpm test"
+  },
   "devDependencies": {
-    "eslint": "8.18.0",
-    "eslint-config-nzap": "5.3.2",
-    "husky": "8.0.1",
-    "jest": "28.1.2",
-    "lint-staged": "13.0.3",
-    "prettier": "2.7.1"
+    "@biomejs/biome": "2.4.10",
+    "@types/node": "22.10.2",
+    "@vitest/coverage-v8": "2.1.8",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8"
   }
 }

package/readme.md

@@ -1,33 +1,39 @@
 # calc-vpd
 
-![Node.js CI](https://github.com/elzup/calc-vpd/workflows/Node.js%20CI/badge.svg)
-[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)
+![Node CI](https://github.com/elzup/calc-vpd/workflows/Node%20CI/badge.svg)
 
-> VPD (Vapor Pressure Deficit) function
+> VPD (Vapor Pressure Deficit / 飽差) function
 
-- 水蒸気圧 = 6.1078 \* 10 ^ ((7.5 - 気温 / (気温 + 237.3)))
-- 飽和水蒸気量 = 217 - 水蒸気圧 / (気温 + 273.15)
-- 飽差 = (100 - 相対湿度) \* 飽和水蒸気量 / 100
+気温と相対湿度から水蒸気圧・飽和水蒸気量・飽差を計算します。
+
+- 水蒸気圧 vp = 6.1078 \* 10 ^ (7.5 \* 気温 / (気温 + 237.3))
+- 飽和水蒸気量 swv = 217 \* vp / (気温 + 273.15)
+- 飽差 vpd = (100 - 相対湿度) \* swv / 100
 
 参考: http://bigbearfarm.blog.fc2.com/blog-entry-306.html
 
 ## Install
 
+```sh
+npm install calc-vpd
+# or: pnpm add calc-vpd
 ```
-$ npm install calc-vpd
-```
+
+ESM / CommonJS / 型定義に対応。
 
 ## Usage
 
-```js
-const calcVpd = require('calc-vpd')
+```ts
+// ESM / TypeScript
+import { calcVpd } from 'calc-vpd'
 
 calcVpd({ tmp: 29.2, hmd: 76.5 })
-//=> {
-//     "swv": 29.080252344,
-//     "vp": 40.518038231,
-//     "vpd": 6.833859301,
-//   }
+//=> { vp: 40.518038231, swv: 29.080252344, vpd: 6.833859301 }
+```
+
+```js
+// CommonJS
+const { calcVpd } = require('calc-vpd')
 ```
 
 ## API
@@ -36,18 +42,21 @@ calcVpd({ tmp: 29.2, hmd: 76.5 })
 
 #### input
 
-Type: `{ tmp: number, hmd: number }`
+Type: `{ tmp: number; hmd: number }`
+
+- `tmp`: 気温 (℃)
+- `hmd`: 相対湿度 (%)
+
+`tmp` / `hmd` が number でない場合は `TypeError` を投げます。
 
-tmp: 気温
-hmd: 湿度
+#### returns
 
-#### output
+Type: `{ vp: number; swv: number; vpd: number }`
 
-Type: `{ swv: number, vp: number, vpd number }`<br>
+- `vp`: 水蒸気圧
+- `swv`: 飽和水蒸気量
+- `vpd`: 飽差 (Vapor Pressure Deficit)
 
-vp: 水蒸気圧,
-swv: 飽和水蒸気量,
-vpd: 飽差
 
 ## License
 

package/index.js

@@ -1,21 +0,0 @@
-'use strict'
-
-const floor8 = n => Math.round(n * 10 ** 9) / 10 ** 9
-
-module.exports = (input /*: { tmp: number, hmd: number } */) => {
-  const { tmp, hmd } = input || {}
-
-  if (typeof tmp !== 'number' || typeof hmd !== 'number') {
-    throw new TypeError(
-      `Expected a { tmp: number, hmd: number }, got ${typeof tmp} ${typeof hmd}`
-    )
-  }
-
-  // vaporPressur
-  const vp = floor8(6.1078 * Math.pow(10, (7.5 * tmp) / (tmp + 237.3)))
-  const swv = floor8((217 * vp) / (tmp + 273.15))
-  // amount of saturated water vapor
-  const vpd = floor8(((100 - hmd) * swv) / 100)
-
-  return { vp, swv, vpd }
-}