human-ids 1.0.12 → 1.0.13

package/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.0.13] - 2023-07-10
+
+### Added
+- Added asObject setting to return an object with the words
 ## [1.0.12] - 2023-07-07
 
 ### Fixed

package/README.md

@@ -55,6 +55,9 @@ const settings = {
   adjective: true,
   color: true,
   noun: true,
+  randomOrder: false,
+  separator: '-',
+  asObject: false,
   number: {
     min: 0,
     max: 999,
@@ -76,6 +79,7 @@ The settings object allows you to customize the ID generation process. The avail
     noun: Set to true to include a noun in the ID (default: false).
     randomOrder: Set to true to include a random order in the ID segments (default: false).
     separator: Set to true to change a separator in the ID
+    asObject: Set to true to return an object with the words
     number: An object that configures the number part of the ID:
         min: The minimum value of the number (default: 0).
         max: The maximum value of the number (default: 999).

package/index.d.ts

@@ -6,6 +6,7 @@ declare module 'human-ids' {
     noun?: boolean;
     randomOrder?: boolean;
     separator?: string;
+    asObject?: boolean;
     number?: {
       min?: number;
       max?: number;

package/index.js

@@ -7,6 +7,7 @@ const defaultSettings = {
   noun: true,
   randomOrder: false,
   separator: '-',
+  asObject: false,
   number: {
     min: 0,
     max: 999,
@@ -81,6 +82,15 @@ function generateId(userSettings = {}) {
     parts.sort(() => Math.random() - 0.5);
   }
 
+  if (settings.asObject) {
+    const object = {};
+    const keys = ['adjective', 'color', 'noun', 'number'];
+    parts.forEach((part, index) => {
+      object[keys[index]] = part;
+    });
+    return object;
+  }
+
   return parts.join(`${settings.separator}`);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "human-ids",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "A library to generate human readable IDs",
   "main": "index.js",
   "scripts": {

package/tests/index.test.js

@@ -10,6 +10,7 @@ describe('generateId', () => {
       noun: true,
       randomOrder: true,
       separator: '-',
+      asObject: false,
       number: {
         min: 0,
         max: 9999,