@nevware21/ts-utils

What is @nevware21/ts-utils?

@nevware21/ts-utils is a utility library for TypeScript that provides a variety of helper functions and utilities to simplify common programming tasks. It includes features for object manipulation, array operations, type checking, and more.

What are @nevware21/ts-utils's main functionalities?

Object Manipulation

The `objMap` function allows you to transform the values of an object based on a provided mapping function.

const obj = { a: 1, b: 2, c: 3 };
const newObj = objMap(obj, (value, key) => value * 2);
console.log(newObj); // { a: 2, b: 4, c: 6 }

Array Operations

The `arrayMap` function is similar to JavaScript's native `map` function but provides additional type safety and utility.

const arr = [1, 2, 3, 4];
const newArr = arrayMap(arr, (value) => value * 2);
console.log(newArr); // [2, 4, 6, 8]

Type Checking

The `isString` function is a type guard that checks if a value is a string, providing better type safety in TypeScript.

const value = 'hello';
if (isString(value)) {
  console.log('Value is a string');
}

Deep Cloning

The `deepClone` function creates a deep copy of an object, ensuring that nested objects are also cloned.

const obj = { a: 1, b: { c: 2 } };
const clonedObj = deepClone(obj);
console.log(clonedObj); // { a: 1, b: { c: 2 } }

Other packages similar to @nevware21/ts-utils

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data types. It is more comprehensive and widely used compared to @nevware21/ts-utils, but it may be heavier in terms of bundle size.

ramda

Ramda is a functional programming library for JavaScript that emphasizes immutability and side-effect-free functions. It offers similar utilities for object and array manipulation but follows a functional programming paradigm.

underscore

Underscore is another utility library that provides a variety of functions for working with arrays, objects, and other data types. It is similar to Lodash but has a smaller feature set and is less frequently updated.

README

@nevware21 ts-utils

Common JavaScript/TypeScript helper functions for better minification

Description

This is a collection of general JavaScript functions (written in and for TypeScript) to aid with removing code duplication to assist with minification, the provided functions are expected to only rarely be included in their namespaced environment.

Support for standard JavaScript functions (ES5+) that are not support in all environments will be backed by internal polyfill implementations when not available. All of the polyfill functions are tested against the standard native implementations for node, browser and web-worker to ensure compatibility.

Documentation and details

• Exported functions
• The individual modules

Some polyfills are provided for simple backward compatability to enable the utility functions in older environments (such as ES3 / IE8), you don't have to use or include the provided polyfils (AND they are NOT exported as part of the main module). If you need them you will need to import the "polyfill" file directly or host and load the provided bundle/ts-polyfills-utils.min.js or provide your own alternatives. See Browser Support for details.

Quickstart

Install the npm packare: npm install @nevware21/ts-utils --save

And then just import the helpers and use them.

import { isArray, arrForEach, objForEachKey, objHasOwnProperty } from "@nevware21/ts-utils";

export function simpleTest(theValue: any): string[] {
    let result: any[] = [];

    if (isArray(theValue)) {
        arrForEach(theValue, (value, idx) => {
            if (objHasOwnProperty(theValue, value)) {
                result.push(idx + ":" + value);
            }
        });
    } else {
        objForEachKey(theValue, (key, value) => {
            if (value) {
                result.push(key + "=" + value);
            }
        });
    }
    return result;
}

Or checking if a variable is a string

import { isString } from "@nevware21/ts-utils";

function checkString(value: any) {
    let ug = 1;

    return isString(value);
}

Browser Support

General support is currently set to ES5 supported runtimes higher.

Latest ?	Latest ?	9+ Full ? 8- polyfills needed	Latest ?	Latest ?

Note: While some polyfills are provided to "somewhat" support ES3/IE8 this library does not intend to become a fully fledged polyfill library. And the polyfills provided (or contributed) are just the minimum set that have been required over time. And should be less necessary are time moves forward.

Contributing

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Changelog

v0.2.0 Jun 29th, 2022

Changelog

• #26 Add Object.create and objSetPrototypeOf tests
  • Rollup back typedoc version so descriptions are published
• #23 Add initial math, additional string and throwRangeError
  • Add math floor, ceil, trunc and toInt
  • Add string, pad, slice and trim, rework string file layout
  • Add throwRangeError
• #25 Bump @types/estree from 0.0.51 to 0.0.52
• #24 Bump typedoc from 0.22.18 to 0.23.1
• #22 Bump puppeteer from 14.4.1 to 15.0.2
• #20 Add more tests, add additional string, object helpers and custom error support
  • Split out extend
  • Split out object to avoid circular dependencies
  • Remove partial ES3 compatibility from objDefine functions
  • Add string startsWith and endsWith (with polyfills for IE)
  • Add throwUnsupportedError and createCustomError
  • Increase test coverage
• #19 Add string and object tests -- fixing issues
  • Add combined (merge) coverage report and summary
• #18 Add Security policy and fix a few copyright header comments
• #17 Add web worker tests
  • Add more tests coverage
  • Fix identified issues
• #16 Add Local browser based debugging option
• #15 Add additional tests and browser coverage
• #13 Update Documentation
  • Rework some base functions for better minification
  • Update the polyfill bundle to include more used functions
• #14 Bump mocha from 9.2.2 to 10.0.0
• #12 Add Tests and Coverage, remove rush usage
• #10 Bump @nevware21/grunt-ts-plugin from 0.4.3 to 0.4.5
• #11 Bump @nevware21/grunt-eslint-ts from 0.2.2 to 0.2.4