@poppinss/utils 6.0.0-2 → 6.0.0-3

package/README.md

@@ -1035,16 +1035,14 @@ if (b) {
 }
 ```
 
-Instead of writing conditionals, your can consider using the Object builder fluent API.
+Instead of writing conditionals, you can consider using the Object builder fluent API.
 
 ```ts
 const builder = new ObjectBuilder({ a: 1 })
 
-// Add property if the value is not undefined.
-builder.add('b', b)
-
-// Get the plain object back
-const plainObject = builder.toObject()
+const plainObject = builder
+  .add('b', b)
+  .toObject()
 ```
 
 By default, only the `undefined` values are ignored. However, you can also ignore `null` values.

package/build/src/object_builder.d.ts

@@ -1,10 +1,18 @@
-export declare class ObjectBuilder {
+import { OmitProperties } from './types.js';
+export declare class ObjectBuilder<ReturnType extends Record<string, any>, IgnoreNull extends boolean = false> {
     #private;
-    value: Record<any, any>;
-    constructor(initialValue?: Record<any, any>, ignoreNull?: boolean);
-    add(key: string, value: any): this;
-    remove(key: string): this;
-    has(key: string): boolean;
-    get<T extends any>(key: string): T;
-    toObject(): Record<any, any>;
+    values: ReturnType;
+    constructor(initialValue: ReturnType, ignoreNull?: IgnoreNull);
+    add<Prop extends string>(key: Prop, value: undefined): this;
+    add<Prop extends string, Value>(key: Prop, value: Value): ObjectBuilder<ReturnType & {
+        [P in Prop]: Value;
+    }, IgnoreNull>;
+    remove<K extends keyof ReturnType>(key: K): this;
+    has<K extends keyof ReturnType>(key: K): boolean;
+    get<K extends keyof ReturnType>(key: K): ReturnType[K];
+    toObject(): IgnoreNull extends true ? {
+        [K in keyof OmitProperties<ReturnType, null>]: ReturnType[K];
+    } : {
+        [K in keyof ReturnType]: ReturnType[K];
+    };
 }

package/build/src/object_builder.js

@@ -1,8 +1,8 @@
 export class ObjectBuilder {
     #ignoreNull;
-    value = {};
+    values;
     constructor(initialValue, ignoreNull) {
-        this.value = initialValue !== undefined ? initialValue : {};
+        this.values = initialValue;
         this.#ignoreNull = ignoreNull === true ? true : false;
     }
     add(key, value) {
@@ -12,20 +12,21 @@ export class ObjectBuilder {
         if (this.#ignoreNull === true && value === null) {
             return this;
         }
-        this.value[key] = value;
+        ;
+        this.values[key] = value;
         return this;
     }
     remove(key) {
-        delete this.value[key];
+        delete this.values[key];
         return this;
     }
     has(key) {
         return this.get(key) !== undefined;
     }
     get(key) {
-        return this.value[key];
+        return this.values[key];
     }
     toObject() {
-        return this.value;
+        return this.values;
     }
 }

package/build/src/types.d.ts

@@ -1,3 +1,7 @@
+declare type PickKeysByValue<T, V> = {
+    [K in keyof T]: T[K] extends V ? K : never;
+}[keyof T];
+export declare type OmitProperties<T, P> = Omit<T, PickKeysByValue<T, P>>;
 declare type ScanFsBaseOptions = {
     ignoreMissingRoot?: boolean;
     filter?: (filePath: string, index: number) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.0.0-2",
+  "version": "6.0.0-3",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -60,9 +60,9 @@
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
-    "@swc/core": "^1.3.10",
+    "@swc/core": "^1.3.11",
     "@types/fs-extra": "^9.0.13",
-    "@types/node": "^18.11.3",
+    "@types/node": "^18.11.7",
     "c8": "^7.12.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.26.0",