@etsoo/shared 1.1.8 → 1.1.9

package/README.md

@@ -151,6 +151,7 @@ String and other related utilities
 
 |Name|Description|
 |---:|---|
+|addBlankItem|Add blank item to collection|
 |charsToNumber|Base64 chars to number|
 |correctTypes|Correct object's property value type|
 |equals|Two values equal|

package/__tests__/Utils.ts

@@ -1,5 +1,16 @@
 import { Utils } from '../src/Utils';
 
+test('Tests for addBlankItem', () => {
+    const options = [
+        { id: 1, name: 'a' },
+        { id: 2, name: 'b' }
+    ];
+    Utils.addBlankItem(options, 'id', 'name');
+    expect(options.length).toBe(3);
+    expect(options[0].id).toBe('');
+    expect(options[0].name).toBe('---');
+});
+
 test('Tests for correctTypes', () => {
     const input = {
         id: '1',

package/lib/cjs/Utils.d.ts

@@ -35,6 +35,14 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem<T extends {}>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars

package/lib/cjs/Utils.js

@@ -29,6 +29,21 @@ String.prototype.removeNonLetters = function () {
  */
 var Utils;
 (function (Utils) {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem(options, idField, labelField, blankLabel) {
+        const blankItem = {
+            [idField !== null && idField !== void 0 ? idField : 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+        };
+        options.unshift(blankItem);
+    }
+    Utils.addBlankItem = addBlankItem;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars

package/lib/mjs/Utils.d.ts

@@ -35,6 +35,14 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem<T extends {}>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars

package/lib/mjs/Utils.js

@@ -26,6 +26,21 @@ String.prototype.removeNonLetters = function () {
  */
 export var Utils;
 (function (Utils) {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem(options, idField, labelField, blankLabel) {
+        const blankItem = {
+            [idField !== null && idField !== void 0 ? idField : 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+        };
+        options.unshift(blankItem);
+    }
+    Utils.addBlankItem = addBlankItem;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.8",
+    "version": "1.1.9",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -57,7 +57,7 @@
         "@types/jest": "^27.4.0",
         "@typescript-eslint/eslint-plugin": "^5.10.1",
         "@typescript-eslint/parser": "^5.10.1",
-        "eslint": "^8.7.0",
+        "eslint": "^8.8.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.4",
         "jest": "^27.4.7",

package/src/Utils.ts

@@ -77,6 +77,27 @@ String.prototype.removeNonLetters = function (this: string) {
  * Utilities
  */
 export namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    export function addBlankItem<T extends {}>(
+        options: T[],
+        idField?: string | keyof T,
+        labelField?: unknown,
+        blankLabel?: string
+    ) {
+        const blankItem: any = {
+            [idField ?? 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']:
+                blankLabel ?? '---'
+        };
+        options.unshift(blankItem);
+    }
+
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars