@esm-test/guards 1.0.0-beta.5 → 1.0.0-beta.7

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 1.0.0-beta.7
+
+  - fixed index.d.ts fn name for throwNotStringOrEmpty
+
+# 1.0.0-beta.6
+
+- added throwEmpty (for strings)
+
+- added aggregate guards
+  - throwUndefinedOrNull
+  - throwNotSetOrEmpty
+
+# 1.0.0-beta.5
+
+- added cjs dist output
+
 # 1.0.0-beta.3
 
 - moved package to @esm-test npm org

package/index.d.ts

@@ -8,16 +8,24 @@ declare module '@esm-test/guards' {
   export function notAnyInstanceMessage(guardInstance: object, ...guardTypes: Object[]): string;
   export function throwNotAnyInstance(guardInstance: object, ...guardTypes: Object[]): void;
 
-  export function nullMessage(guardName: string): string;
-  export function throwNull(guardName: string, guard: object): void;
-
   export function notObjectKeyMessage(guardName: string, guard: object): string;
   export function throwNotObjectKey(guardName: string, guard: object, guardObjectKey: string): void;
-  
+
   export function notTypeMessage(guardName: string, guardType: string): string;
   export function throwNotType(guardName: string, guard: object, guardType: string): void;
-  
+
+  export type TGuardable = object | string | number | boolean | bigint | symbol | null | undefined;
+
+  export function nullMessage(guardName: string): string;
+  export function throwNull(guardName: string, guard: TGuardable): void;
+
   export function undefinedMessage(guardName: string): string;
-  export function throwUndefined(guardName: string, guard: object): void;
+  export function throwUndefined(guardName: string, guard: TGuardable): void;
+
+  export function emptyMessage(guardName: string): string;
+  export function throwEmpty(guardName: string, guard: string): void;
+
+  export function throwUndefinedOrNull(guardName: string, guard: TGuardable): void;
+  export function throwNotStringOrEmpty(guardName: string, guard: string): void;
 
 }

package/legacy/src/guardAggregates.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwNotStringOrEmpty = exports.throwUndefinedOrNull = void 0;
+const guardEmpty_js_1 = require("./guardEmpty.cjs");
+const guardNull_js_1 = require("./guardNull.cjs");
+const guardType_js_1 = require("./guardType.cjs");
+const guardUndefined_js_1 = require("./guardUndefined.cjs");
+/**
+ * @param {string} guardName
+ * @param {import("@esm-test/guards").TGuardable} guard
+ */
+const throwUndefinedOrNull = (guardName, guard) => {
+    (0, guardUndefined_js_1.throwUndefined)(guardName, guard);
+    (0, guardNull_js_1.throwNull)(guardName, guard);
+};
+exports.throwUndefinedOrNull = throwUndefinedOrNull;
+/**
+ * @param {string} guardName
+ * @param {string} guard
+ */
+const throwNotStringOrEmpty = (guardName, guard) => {
+    (0, guardUndefined_js_1.throwUndefined)(guardName, guard);
+    (0, guardNull_js_1.throwNull)(guardName, guard);
+    (0, guardType_js_1.throwNotType)(guardName, guard, 'string');
+    (0, guardEmpty_js_1.throwEmpty)(guardName, guard);
+};
+exports.throwNotStringOrEmpty = throwNotStringOrEmpty;
+//# sourceMappingURL=guardAggregates.cjs.map

package/legacy/src/guardAggregates.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardAggregates.cjs","sourceRoot":"","sources":["../../src/guardAggregates.js"],"names":[],"mappings":";;;AAAA,mDAA6C;AAC7C,iDAA2C;AAC3C,iDAA8C;AAC9C,2DAAqD;AAErD;;;GAGG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IACvD,IAAA,kCAAc,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjC,IAAA,wBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC9B,CAAC,CAAA;AAHY,QAAA,oBAAoB,wBAGhC;AAED;;;GAGG;AACI,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IACxD,IAAA,kCAAc,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjC,IAAA,wBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5B,IAAA,2BAAY,EAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;IACxC,IAAA,0BAAU,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC/B,CAAC,CAAA;AALY,QAAA,qBAAqB,yBAKjC"}

package/legacy/src/guardEmpty.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwEmpty = exports.emptyMessage = void 0;
+/**
+ * @param {string} guardName
+ */
+const emptyMessage = (guardName) => `${guardName} is empty`;
+exports.emptyMessage = emptyMessage;
+/**
+ * @param {string} guardName
+ * @param {string} guard
+ */
+const throwEmpty = (guardName, guard) => {
+    const isEmpty = guard === '';
+    if (isEmpty) {
+        throw new Error((0, exports.emptyMessage)(guardName));
+    }
+};
+exports.throwEmpty = throwEmpty;
+//# sourceMappingURL=guardEmpty.cjs.map

package/legacy/src/guardEmpty.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardEmpty.cjs","sourceRoot":"","sources":["../../src/guardEmpty.js"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,SAAS,WAAW,CAAC;AAAtD,QAAA,YAAY,gBAA0C;AAEnE;;;GAGG;AACI,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;IAC7C,MAAM,OAAO,GAAG,KAAK,KAAK,EAAE,CAAC;IAC7B,IAAI,OAAO,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,IAAA,oBAAY,EAAC,SAAS,CAAC,CAAC,CAAC;KAC1C;AACH,CAAC,CAAA;AALY,QAAA,UAAU,cAKtB"}

package/legacy/src/guardNull.cjs

@@ -8,7 +8,7 @@ const nullMessage = (guardName) => `${guardName} is null`;
 exports.nullMessage = nullMessage;
 /**
  * @param {string} guardName
- * @param {object} guard
+ * @param {import("@esm-test/guards").TGuardable} guard
  */
 const throwNull = (guardName, guard) => {
     const isNull = guard !== null;

package/legacy/src/guardUndefined.cjs

@@ -8,7 +8,7 @@ const undefinedMessage = (guardName) => `${guardName} is not defined`;
 exports.undefinedMessage = undefinedMessage;
 /**
  * @param {string} guardName
- * @param {object} guard
+ * @param {import("@esm-test/guards").TGuardable} guard
  */
 const throwUndefined = (guardName, guard) => {
     const isDefined = guard !== undefined;

package/legacy/src/index.cjs

@@ -14,10 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./guardAggregates.cjs"), exports);
 __exportStar(require("./guardComplexObject.cjs"), exports);
-__exportStar(require("./guardObjectKey.cjs"), exports);
+__exportStar(require("./guardEmpty.cjs"), exports);
 __exportStar(require("./guardInstance.cjs"), exports);
 __exportStar(require("./guardNull.cjs"), exports);
+__exportStar(require("./guardObjectKey.cjs"), exports);
 __exportStar(require("./guardType.cjs"), exports);
 __exportStar(require("./guardUndefined.cjs"), exports);
 //# sourceMappingURL=index.cjs.map

package/legacy/src/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,sDAAoC;AACpC,qDAAmC;AACnC,iDAA+B;AAC/B,iDAA+B;AAC/B,sDAAoC"}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,0DAAwC;AACxC,kDAAgC;AAChC,qDAAmC;AACnC,iDAA+B;AAC/B,sDAAoC;AACpC,iDAA+B;AAC/B,sDAAoC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esm-test/guards",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0-beta.7",
   "description": "A js utility library for guarding objects, instances and types",
   "publishConfig": {
     "access": "public"

package/src/guardAggregates.js

@@ -0,0 +1,24 @@
+import { throwEmpty } from "./guardEmpty.js";
+import { throwNull } from "./guardNull.js";
+import { throwNotType } from "./guardType.js";
+import { throwUndefined } from "./guardUndefined.js";
+
+/**
+ * @param {string} guardName
+ * @param {import("@esm-test/guards").TGuardable} guard
+ */
+export const throwUndefinedOrNull = (guardName, guard) => {
+  throwUndefined(guardName, guard);
+  throwNull(guardName, guard);
+}
+
+/**
+ * @param {string} guardName
+ * @param {string} guard
+ */
+export const throwNotStringOrEmpty = (guardName, guard) => {
+  throwUndefined(guardName, guard);
+  throwNull(guardName, guard);
+  throwNotType(guardName, guard, 'string')
+  throwEmpty(guardName, guard);
+}

package/src/guardEmpty.js

@@ -0,0 +1,15 @@
+/**
+ * @param {string} guardName
+ */
+export const emptyMessage = (guardName) => `${guardName} is empty`;
+
+/**
+ * @param {string} guardName
+ * @param {string} guard
+ */
+export const throwEmpty = (guardName, guard) => {
+  const isEmpty = guard === '';
+  if (isEmpty) {
+    throw new Error(emptyMessage(guardName));
+  }
+}

package/src/guardNull.js

@@ -5,7 +5,7 @@ export const nullMessage = (guardName) => `${guardName} is null`;
 
 /**
  * @param {string} guardName
- * @param {object} guard
+ * @param {import("@esm-test/guards").TGuardable} guard
  */
 export const throwNull = (guardName, guard) => {
   const isNull = guard !== null;

package/src/guardUndefined.js

@@ -5,7 +5,7 @@ export const undefinedMessage = (guardName) => `${guardName} is not defined`;
 
 /**
  * @param {string} guardName
- * @param {object} guard
+ * @param {import("@esm-test/guards").TGuardable} guard
  */
 export const throwUndefined = (guardName, guard) => {
   const isDefined = guard !== undefined;

package/src/index.js

@@ -1,6 +1,8 @@
+export * from './guardAggregates.js';
 export * from './guardComplexObject.js';
-export * from './guardObjectKey.js';
+export * from './guardEmpty.js';
 export * from './guardInstance.js';
 export * from './guardNull.js';
+export * from './guardObjectKey.js';
 export * from './guardType.js';
 export * from './guardUndefined.js';