mechanical-tolerance-calculator 1.1.8 → 1.1.9

package/index.js

@@ -1,14 +1,24 @@
 const tolerances = require("./Tolerances.json");
 
+/* Validates the material type passed is not an empty string. */
+function validateMaterialType(materialType) {
+  if (typeof materialType != "string") {
+    // checks if
+    return { error: "Material type must be a string." };
+  }
+
+  if (
+    materialType == undefined ||
+    materialType == null ||
+    materialType.trim() === ""
+  ) {
+    return { error: "Material type is required and cannot be empty." };
+  }
+
+  return materialType;
+}
 /**
  * Returns all tolerances for the given material type.
- * @description
- * The function checks the provided material type string to determine
- * which category of tolerances to return. It supports 'housing', 'shaft',
- * and 'shell' as valid material types. If the input is invalid or does not
- * match any known category, an error message is returned.
- * @param {string} materialType
- * @returns {object} An object containing the relevant tolerances or an error message.
  */
 function getAllTolerancesFor(materialType) {
   const validatedMaterialType = validateMaterialType(materialType);
@@ -32,13 +42,6 @@ function getAllTolerancesFor(materialType) {
 
 /**
  * Returns Camco Standard specification and tolerances for the given material type.
- * @description
- * The function checks the provided material type string to determine
- * which category of camco standard tolerances to return. It supports 'housing', 'shaft',
- * and 'shell' as valid material types. If the input is invalid or does not
- * match any known category, an error message is returned.
- * @param {string} materialType
- * @returns {object} An object containing the relevant tolerances or an error message.
  */
 function getCamcoStandardTolerancesFor(materialType) {
   const validatedMaterialType = validateMaterialType(materialType);
@@ -58,22 +61,6 @@ function getCamcoStandardTolerancesFor(materialType) {
   }
 }
 
-function validateMaterialType(materialType) {
-  if (typeof materialType != "string") {
-    return { error: "Material type must be a string." };
-  }
-
-  if (
-    materialType == undefined ||
-    materialType == null ||
-    materialType.trim() === ""
-  ) {
-    return { error: "Material type is required and cannot be empty." };
-  }
-
-  return materialType;
-}
-
 function returnTolerancesFor(executableMaterialType, spec = "") {
   if (spec) {
     const allTolerances = tolerances[executableMaterialType];
@@ -468,6 +455,7 @@ function checkMultipleMeasurementsFor(materialType, measurements) {
     meets_specification: { meetsSpec, reason: specMeetingReason },
     meets_IT_Tolerance: { meetsIT, reason: itMeetingReason },
     meets_final_compliance: meetsIT === true && meetsSpec === true,
+    generalized_outcome: outcome,
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mechanical-tolerance-calculator",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "Calculates international standard specification and  tolerances for bores, round bars and metals of mechanical units. For examples; H7, H8, H9, h8, h9 specifications and IT5/IT6 tolerances.",
   "main": "index.js",
   "scripts": {

package/test.js

@@ -1,9 +1,4 @@
 const { checkMultipleMeasurementsFor } = require("./index");
 // console.log(checkMultipleMeasurementsFor("housing", [100.04, 100.05]));
 // console.log(checkMultipleMeasurementsFor("housing", [100.04, 100.05, 95.06]));
-console.log(
-  checkMultipleMeasurementsFor(
-    "housing",
-    [100.04, 100.05, 100.05, 98.08, 98.07, 100.09, 98.07, 98.03],
-  ),
-);
+console.log(checkMultipleMeasurementsFor("shaft", [98.99, 98.98]));