@elyukai/utils 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.1.6](https://github.com/elyukai/ts-utils/compare/v0.1.5...v0.1.6) (2026-01-28)
+
+
+### Bug Fixes
+
+* signature of map method ([3f8197f](https://github.com/elyukai/ts-utils/commit/3f8197fc7e8d5a003d493ae1460060e0c868e4db))
+
+## [0.1.5](https://github.com/elyukai/ts-utils/compare/v0.1.4...v0.1.5) (2026-01-28)
+
+
+### Features
+
+* add toJSON to dictionary ([0418666](https://github.com/elyukai/ts-utils/commit/0418666bdb189c0c70813661ffb5763b31074ed0))
+* types dictionary keys ([0df86ce](https://github.com/elyukai/ts-utils/commit/0df86ce50bbfdc13353b1a17ab3de9d9ca56d19d))
+
 ## [0.1.4](https://github.com/elyukai/ts-utils/compare/v0.1.3...v0.1.4) (2026-01-24)
 
 

package/dist/dictionary.d.ts

@@ -6,44 +6,44 @@ import type { AnyNonNullish } from "./nullable.js";
 /**
  * An immutable dictionary mapping strings to values.
  */
-export declare class Dictionary<T extends AnyNonNullish | null> {
+export declare class Dictionary<T extends AnyNonNullish | null, K extends string = string> {
     private record;
     /**
      * Creates a new dictionary from an indexed object.
      */
-    constructor(record: Record<string, T>);
+    constructor(record: Partial<Record<K, T>>);
     /**
      * An empty dictionary.
      */
-    static empty: Dictionary<never>;
+    static empty: Dictionary<never, never>;
     /**
      * Constructs a dictionary from an array of key-value pairs.
      */
-    static fromEntries<T extends AnyNonNullish | null>(entries: [string, T][]): Dictionary<T>;
+    static fromEntries<T extends AnyNonNullish | null, K extends string = string>(entries: [K, T][]): Dictionary<T, K>;
     /**
      * Returns the value associated with the given key, or `undefined` if the key does not exist.
      */
-    get(key: string): T | undefined;
+    get(key: K): T | undefined;
     /**
      * Returns the value associated with the given key mapped through the given function, or `undefined` if the key does not exist.
      */
-    getMap<U>(key: string, mapFn: (value: T) => U): U | undefined;
+    getMap<U>(key: K, mapFn: (value: T) => U): U | undefined;
     /**
      * Checks if the dictionary has the given key.
      */
-    has(key: string): boolean;
+    has(key: K): boolean;
     /**
      * Sets the given key to the given value.
      *
      * If the key already exists, its value will be overwritten.
      */
-    set(key: string, value: T): Dictionary<T>;
+    set(key: K, value: T): Dictionary<T, K>;
     /**
      * Removes the given key from the dictionary.
-     *
+     *hs
      * If the key does not exist, the same dictionary instance is returned.
      */
-    remove(key: string): Dictionary<T>;
+    remove(key: K): Dictionary<T, K>;
     /**
      * The number of entries in the dictionary.
      */
@@ -51,7 +51,7 @@ export declare class Dictionary<T extends AnyNonNullish | null> {
     /**
      * Returns an array of key-value pairs in the dictionary.
      */
-    entries(): [string, T][];
+    entries(): [K, T][];
     /**
      * Returns an array of values in the dictionary.
      */
@@ -59,17 +59,17 @@ export declare class Dictionary<T extends AnyNonNullish | null> {
     /**
      * Returns an array of keys in the dictionary.
      */
-    keys(): string[];
+    keys(): K[];
     /**
      * Calls the given function for each key-value pair in the dictionary.
      */
-    forEach(fn: (value: T, key: string) => void): void;
+    forEach(fn: (value: T, key: K) => void): void;
     /**
      * Calls the given async function for each key-value pair in the dictionary.
      *
      * The calls are made sequentially.
      */
-    forEachAsync(fn: (value: T, key: string) => Promise<void>): Promise<void>;
+    forEachAsync(fn: (value: T, key: K) => Promise<void>): Promise<void>;
     /**
      * Create, modify, or remove the value for the given key based on its current value.
      *
@@ -77,39 +77,45 @@ export declare class Dictionary<T extends AnyNonNullish | null> {
      * If the `modifyFn` returns `undefined`, the key will be removed from the dictionary.
      * Otherwise, the key will be set to the new value returned by `modifyFn`.
      */
-    modify(key: string, modifyFn: (currentValue: T | undefined) => T | undefined): Dictionary<T>;
+    modify(key: K, modifyFn: (currentValue: T | undefined) => T | undefined): Dictionary<T, K>;
     /**
      * Returns the first value that matches the given predicate, or `undefined` if
      * no such value exists.
      */
-    find<U extends T>(predicate: (value: T, key: string) => value is U): U | undefined;
+    find<U extends T>(predicate: (value: T, key: K) => value is U): U | undefined;
     /**
      * Returns the first value that matches the given predicate, or `undefined` if
      * no such value exists.
      */
-    find(predicate: (value: T, key: string) => boolean): T | undefined;
+    find(predicate: (value: T, key: K) => boolean): T | undefined;
     /**
      * Returns the first key that matches the given predicate, or `undefined` if no such key exists.
      */
-    findKey(predicate: (value: T, key: string) => boolean): string | undefined;
+    findKey(predicate: (value: T, key: K) => boolean): string | undefined;
     /**
      * Returns the first key-value pair that matches the given predicate, or `undefined` if no such key-value pair exists.
      */
-    findEntry<U extends T>(predicate: (value: T, key: string) => value is U): [key: string, value: U] | undefined;
+    findEntry<U extends T>(predicate: (value: T, key: K) => value is U): [key: K, value: U] | undefined;
     /**
      * Returns the first key-value pair that matches the given predicate, or `undefined` if no such key-value pair exists.
      */
-    findEntry(predicate: (value: T, key: string) => boolean): [key: string, value: T] | undefined;
+    findEntry(predicate: (value: T, key: K) => boolean): [key: K, value: T] | undefined;
     /**
      * Applies the given mapping function to each key-value pair in the dictionary and returns the first non-`undefined` result, or `undefined` if no such result exists.
      */
-    mapFirst<U extends AnyNonNullish | null>(mapFn: (value: T, key: string) => U | undefined): U | undefined;
+    mapFirst<U extends AnyNonNullish | null>(mapFn: (value: T, key: K) => U | undefined): U | undefined;
     /**
      * Applies a function to every key-value pair in the dictionary.
      */
-    map<U extends AnyNonNullish | null>(mapFn: (value: T, key: string) => U): Dictionary<U>;
+    map<U extends AnyNonNullish | null>(mapFn: (value: T, key: K) => U): Dictionary<U, K>;
     /**
      * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
      */
     reduce<U>(reducer: (acc: U, value: T, key: string) => U, initialValue: U): U;
+    /**
+     * Converts the dictionary to a plain object.
+     *
+     * This is automatically called when using `JSON.stringify`.
+     */
+    toJSON(): Partial<Record<K, T>>;
 }

package/dist/dictionary.js

@@ -2,7 +2,7 @@
  * Introduces a Dictionary class that represents an immutable mapping from strings to values.
  * @module
  */
-import { omitKeys } from "./object.js";
+import { omitKeys, omitUndefinedKeys } from "./object.js";
 /**
  * An immutable dictionary mapping strings to values.
  */
@@ -12,7 +12,7 @@ export class Dictionary {
      * Creates a new dictionary from an indexed object.
      */
     constructor(record) {
-        this.record = record;
+        this.record = omitUndefinedKeys(record);
     }
     /**
      * An empty dictionary.
@@ -53,7 +53,7 @@ export class Dictionary {
     }
     /**
      * Removes the given key from the dictionary.
-     *
+     *hs
      * If the key does not exist, the same dictionary instance is returned.
      */
     remove(key) {
@@ -68,7 +68,7 @@ export class Dictionary {
      * The number of entries in the dictionary.
      */
     get size() {
-        return Object.keys(this.record).length;
+        return this.keys().length;
     }
     /**
      * Returns an array of key-value pairs in the dictionary.
@@ -92,7 +92,7 @@ export class Dictionary {
      * Calls the given function for each key-value pair in the dictionary.
      */
     forEach(fn) {
-        for (const [key, value] of Object.entries(this.record)) {
+        for (const [key, value] of this.entries()) {
             fn(value, key);
         }
     }
@@ -102,7 +102,7 @@ export class Dictionary {
      * The calls are made sequentially.
      */
     async forEachAsync(fn) {
-        for (const [key, value] of Object.entries(this.record)) {
+        for (const [key, value] of this.entries()) {
             await fn(value, key);
         }
     }
@@ -140,7 +140,7 @@ export class Dictionary {
      * Returns the first key-value pair that matches the given predicate, or `undefined` if no such key-value pair exists.
      */
     findEntry(predicate) {
-        for (const [key, value] of Object.entries(this.record)) {
+        for (const [key, value] of this.entries()) {
             if (predicate(value, key)) {
                 return [key, value];
             }
@@ -151,7 +151,7 @@ export class Dictionary {
      * Applies the given mapping function to each key-value pair in the dictionary and returns the first non-`undefined` result, or `undefined` if no such result exists.
      */
     mapFirst(mapFn) {
-        for (const [key, value] of Object.entries(this.record)) {
+        for (const [key, value] of this.entries()) {
             const mapped = mapFn(value, key);
             if (mapped !== undefined) {
                 return mapped;
@@ -164,7 +164,7 @@ export class Dictionary {
      */
     map(mapFn) {
         const newRecord = {};
-        for (const [key, value] of Object.entries(this.record)) {
+        for (const [key, value] of this.entries()) {
             newRecord[key] = mapFn(value, key);
         }
         return new Dictionary(newRecord);
@@ -173,6 +173,14 @@ export class Dictionary {
      * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
      */
     reduce(reducer, initialValue) {
-        return Object.entries(this.record).reduce((acc, [key, item]) => reducer(acc, item, key), initialValue);
+        return this.entries().reduce((acc, [key, item]) => reducer(acc, item, key), initialValue);
+    }
+    /**
+     * Converts the dictionary to a plain object.
+     *
+     * This is automatically called when using `JSON.stringify`.
+     */
+    toJSON() {
+        return { ...this.record };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elyukai/utils",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "A set of JavaScript helper functions.",
   "files": [
     "dist",