added getTupleValuesByProperty

Author: hunterwilhelm

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.0.5] - 2025-06-09
+
+### Added
+- Added getTupleValuesByProperty
+
+### Fixed
+- KeyName conflict will show the error on the right line
+
 ## [0.0.4] - 2025-06-06
 
 ### Added

dist/butterKeyedEnum.d.ts

@@ -46,7 +46,12 @@
  * @throws {Error} If the `tupleFactory` does not return a tuple that includes all keys, a compile-time type error will occur.
  */
 export declare function ButterKeyedEnum<KeyName extends string = "key", const T extends {
-    [K in keyof T]: KeyName extends keyof T[K] ? never : Record<string, any>;
+    [K in keyof T]: KeyName extends keyof T[K] ? {
+        [K2 in keyof T[K]]: K2 extends KeyName ? {
+            error: "You must not include the keyName in the inner objects";
+            value: never;
+        } : any;
+    } & Record<string, any> : Record<string, any>;
 } = {
     [key: string]: any;
 }, TTuple extends [T[keyof T], ...T[keyof T][]] = [T[keyof T], ...T[keyof T][]], TResult extends [T[keyof T], ...T[keyof T][]] = TTuple>(enumObject: T, options: {
@@ -83,7 +88,34 @@ export declare function ButterKeyedEnum<KeyName extends string = "key", const T
      * @type {TTuple} The tuple of enum values in the order defined by tupleFactory
      */
     readonly tuple: TResult;
-    readonly mapTuple: <U>(fn: (value: TResult[number], index: number, array: TResult) => U) => { [K in keyof TResult]: U; };
+    /**
+     * Maps a property of the tuple to an array of values
+     *
+     * @example
+     * ```typescript
+     * const colorsEnum = ButterKeyedEnum({
+     *   green: {
+     *     emoji: '🟩',
+     *     hex: '#00FF00',
+     *   },
+     *   red: {
+     *     emoji: '🟥',
+     *     hex: '#FF0000',
+     *   },
+     * }, {
+     *   tupleFactory: (enumObject) => [
+     *     enumObject.green,
+     *     enumObject.red,
+     *   ]
+     * })
+     *
+     * colorsEnum.getTupleValuesByProperty('emoji') // ['🟩', '🟥']
+     * ```
+     *
+     * @param property The property to map
+     * @returns An array of values from the tuple
+     */
+    readonly getTupleValuesByProperty: <TProperty extends keyof TResult[number]>(property: TProperty) => { [TIndex in keyof TResult]: TResult[TIndex][TProperty]; };
     /**
      * Gets a value by key
      *

dist/butterKeyedEnum.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ButterKeyedEnum = ButterKeyedEnum;
 const deep_freeze_es6_1 = __importDefault(require("deep-freeze-es6"));
-const mapTuple_1 = require("./mapTuple");
 /**
  * Butter Keyed Enum
  *
@@ -73,7 +72,36 @@ function ButterKeyedEnum(enumObject, options) {
          * @type {TTuple} The tuple of enum values in the order defined by tupleFactory
          */
         tuple: $tuple,
-        mapTuple: (fn) => (0, mapTuple_1.mapTuple)($tuple, fn),
+        /**
+         * Maps a property of the tuple to an array of values
+         *
+         * @example
+         * ```typescript
+         * const colorsEnum = ButterKeyedEnum({
+         *   green: {
+         *     emoji: '🟩',
+         *     hex: '#00FF00',
+         *   },
+         *   red: {
+         *     emoji: '🟥',
+         *     hex: '#FF0000',
+         *   },
+         * }, {
+         *   tupleFactory: (enumObject) => [
+         *     enumObject.green,
+         *     enumObject.red,
+         *   ]
+         * })
+         *
+         * colorsEnum.getTupleValuesByProperty('emoji') // ['🟩', '🟥']
+         * ```
+         *
+         * @param property The property to map
+         * @returns An array of values from the tuple
+         */
+        getTupleValuesByProperty(property) {
+            return $tuple.map((value) => value[property]);
+        },
         /**
          * Gets a value by key
          *

dist/butterTupleEnum.d.ts

@@ -25,7 +25,6 @@ export declare function ButterTupleEnum<const T extends readonly string[]>(tuple
      * @type {T} The tuple of strings
      */
     tuple: T;
-    mapTuple: <U>(fn: (value: T[number], index: number, tuple: T) => U) => { [K in keyof T]: U; };
     /**
      * The enum object
      *

dist/butterTupleEnum.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ButterTupleEnum = ButterTupleEnum;
 const deep_freeze_es6_1 = __importDefault(require("deep-freeze-es6"));
-const mapTuple_1 = require("./mapTuple");
 /**
  * Butter Tuple Enum
  *
@@ -36,7 +35,6 @@ function ButterTupleEnum(tuple) {
          * @type {T} The tuple of strings
          */
         tuple: $tuple,
-        mapTuple: (fn) => (0, mapTuple_1.mapTuple)($tuple, fn),
         /**
          * The enum object
          *

dist/index.d.ts

@@ -1,3 +1,2 @@
 export * from './butterKeyedEnum';
 export * from './butterTupleEnum';
-export * from './mapTuple';

dist/index.js

@@ -16,4 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./butterKeyedEnum"), exports);
 __exportStar(require("./butterTupleEnum"), exports);
-__exportStar(require("./mapTuple"), exports);

dist/mapTuple.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "butter-enums",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Typesafe specialized enums for TypeScript - Smooth like butter",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",