@didiermargarido/ts-utilities v1.2.0

TS Utilities

TS Utilities is a versatile collection of TypeScript utility functions designed to simplify your development tasks.\ It provides a range of helpful functions for various common scenarios.

Installation

To incorporate TS Utilities into your TypeScript projects, you can use either npm or yarn package manager.\ Choose the one you're most comfortable with:

Using NPM

npm install @didiermargarido/ts-utilities

Using Yarn

yarn add @didiermargarido/ts-utilities

Usage

TS Utilities provides a comprehensive set of utility functions that can streamline various aspects of your TypeScript projects.\ Here's a detailed guide on how to use some of the key utility functions available in TS Utilities:

isDefined

Method to check if value is defined.

// Util
import { isDefined } from "@didiermargarido/ts-utilities";

// Output: true
isDefined("DM");
isDefined(10);
isDefined([]);

// Output: false
isDefined(null);
isDefined(undefined); 

isEmpty

Method to check if value is empty.

// Util
import { isEmpty } from "@didiermargarido/ts-utilities";

// Output: true
isEmpty("");
isEmpty([]);
isEmpty({});
isEmpty(null);
isEmpty(undefined);

// Output: false
isEmpty("DM");
isEmpty(["DM", 36]);
isEmpty({ key: "DM" }); 

isEqual

Method to check if two values are equal.

// Util
import { isEqual } from "@didiermargarido/ts-utilities";

// Output: true
isEqual("DM", "DM");
isEqual(true, true);
isEqual([1, 2], [1, 2]);
isEqual([{ key: "DM" }], [{ key: "DM" }]);

// Output: false
isEqual("DM", "MD");
isEqual(true, false);
isEqual({ key: "DM" }, { key: "MD" }); 

deepMerge

Method to merge multiple objects.

// Util
import { deepMerge } from "@didiermargarido/ts-utilities";

// Merge two single objects
const obj1 = { 
  car: "Ford",
};

const obj2 = { 
  car: "Peugeot", 
  color: "White"
};

// Output { car: "Peugeot", color: "White" }
deepMerge(obj1, obj2)

// Merge three objects with nested properties
const obj1 = { 
  car: "Ford", 
  specifications: { 
    km: 15000, 
    diesel: true 
  } 
};

const obj2 = { 
  car: "Peugeot", 
  color: "White"
};

const obj3 = { 
  car: "Peugeot", 
  specifications: { 
    diesel: false
  } 
};

// Output: { car: "Peugeot", color: "White", specifications: { km: 15000, diesel: false } }
deepMerge(obj1, obj2, obj3);

secureMask

Method to securely mask information by revealing specified digits from the start or end.

// Util
import { secureMask } from "@didiermargarido/ts-utilities";

// Optional options allowed
{
  digits: number // default is "4"
  char: string // default is "*"
  pad: "start" | "end" // default is "start"
}

// Output: "*****6789"
secureMask("123456789");

// Output: "*******89"
secureMask(123456789, { digits: 2 });

// Output: "123------"
secureMask("123456789", { digits: 3, char: "-", pad: "end" });

// Output: undefined
secureMask(undefined);
secureMask(null);

Author

Didier Margarido\ github/didiermargarido

License

TS Utilities is open-sourced software licensed under the MIT license