@drunkcod/argis 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tobbe Gyllebring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/index.d.ts

@@ -2,14 +2,26 @@ type NoNullMembers<T> = {
     [P in keyof T]: NonNullable<T[P]>;
 };
 export type WithRequired<T, K extends keyof T> = Required<NoNullMembers<Pick<T, K>>> & Omit<T, K>;
+export type WithKey<K extends PropertyKey, V = unknown> = {
+    [p in K]: V;
+};
 export declare class ArgumentError extends Error {
     constructor(message: string);
     static null(message: string): void;
+    static missing({ key }: {
+        key: PropertyKey;
+    }): void;
 }
+export declare function isNil(x: any): x is null | undefined;
+export declare function isNil<T extends object>(x: T | null, key: keyof T): x is T & WithKey<typeof key, null | undefined>;
+export declare function isNotNil<T>(x?: T): x is T;
 export declare function isNotNil<T, K extends keyof T>(x: T, key: K): x is T & {
     [P in K]-?: NonNullable<T[K]>;
 };
+export declare function assertNotNil<T>(x: T | null): asserts x is T;
 export declare function argNotNil<T, K extends keyof T>(x: T, key: K): asserts x is T & {
     [P in K]-?: NonNullable<T[K]>;
 };
+export declare function hasOwn<T extends object, K extends PropertyKey>(x: T, key: K): x is T & WithKey<K>;
+export declare function assertOwn<T extends object, K extends PropertyKey>(x: T, key: K): asserts x is T & WithKey<K>;
 export {};

package/lib/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArgumentError = void 0;
+exports.isNil = isNil;
 exports.isNotNil = isNotNil;
+exports.assertNotNil = assertNotNil;
 exports.argNotNil = argNotNil;
+exports.hasOwn = hasOwn;
+exports.assertOwn = assertOwn;
 class ArgumentError extends Error {
     constructor(message) {
         super(message);
@@ -12,13 +16,29 @@ class ArgumentError extends Error {
         e.name = 'ArgumentNullError';
         throw e;
     }
+    static missing({ key }) {
+        const e = new ArgumentError(`Missing property ${String(key)}.`);
+        e.name = 'MissingPropertyError';
+        throw e;
+    }
 }
 exports.ArgumentError = ArgumentError;
+function isNil(x, key) {
+    return x == null || (key !== undefined && x[key] == null);
+}
 function isNotNil(x, key) {
-    const v = x[key];
-    return v !== undefined && v !== null;
+    return !isNil(x) && (key === undefined || !isNil(x[key]));
+}
+function assertNotNil(x) {
+    if (x == null)
+        ArgumentError.null('Unexpected null');
 }
-;
 function argNotNil(x, key) {
     isNotNil(x, key) || ArgumentError.null(`'${String(key)}' was null or undefined`);
 }
+function hasOwn(x, key) {
+    return Object.hasOwn(x, key);
+}
+function assertOwn(x, key) {
+    hasOwn(x, key) || ArgumentError.missing({ key });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drunkcod/argis",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Tiny method arg checking with strong types.",
   "scripts": {
     "build": "rimraf lib && tsc",
@@ -8,10 +8,11 @@
   },
   "author": "Tobbe Gyllebring",
   "license": "MIT",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
-    "lib/**/*"
+    "lib/**/*",
+    "!lib/**/*.spec.*"
   ],
   "devDependencies": {
     "@jest/globals": "^29.7.0",