@akb2/types-tools
v1.5.0
Published
Extends tools & types for TypeScript
Readme
@akb2/types-tools
A lightweight TypeScript utility library providing common type helpers and data conversion functions. Designed for consistent and predictable handling of primitive types, arrays, and objects.
Installation
npm install @akb2/types-toolsOverview
This package provides a set of strongly typed utility functions and generic type definitions for working with various data types. It’s intended for use in TypeScript projects that require safe type conversions, validation, and lightweight functional helpers.
Functions
isDefined(value)
Determines whether a value is neither null nor undefined.
isDefined(null); // false
isDefined(undefined); // false
isDefined(0); // true
isDefined(""); // true
isDefined(false); // true
isDefined(NaN); // trueisObject(value)
Checks whether a value is a plain object.
Returns true only for non-null object values that are not arrays and whose prototype is exactly Object.prototype.
This is useful when you want to accept simple object literals while excluding arrays, dates, class instances, and other non-plain objects.
isObject({}); // true
isObject({ a: 1, b: true }); // true
isObject({ nested: { ok: true } }); // true
isObject([]); // false
isObject(new Date()); // false
isObject(null); // false
isObject(undefined); // false
isObject("plain"); // false
isObject(42); // falseanyToFloat(value, defaultValue = 0, precision = -1)
Converts any value to a floating-point number, with optional rounding.
precision = -1→ preserves the number of decimals from the input.
anyToFloat(null); // 0
anyToFloat(undefined); // 0
anyToFloat("", 56); // 56
anyToFloat("42"); // 42
anyToFloat("3.141592653589793", 0, 5); // 3.14159anyToInt(value, defaultValue = 0)
Converts any value to an integer. Falls back to defaultValue if conversion fails.
anyToInt(null); // 0
anyToInt(undefined); // 0
anyToInt("", 56); // 56
anyToInt("42"); // 42
anyToInt("3.141592653589793", 0); // 3anyToString(value, defaultTitle = "")
Converts any value to a string. Returns defaultTitle if value is null or undefined.
anyToString(null); // ""
anyToString(undefined, "Default title"); // "Default title"
anyToString(NaN); // "NaN"
anyToString(false, "not true"); // "false"
anyToString(3.141592653589793); // "3.141592653589793"anyToArray(value)
Ensures the input is an array.
If the value is already an array, it’s returned as-is.
If it’s a single value — it’s wrapped in an array.
If it’s null or undefined — returns an empty array.
anyToArray(null); // []
anyToArray(undefined); // []
anyToArray([]); // []
anyToArray(["a", "b"]); // ["a", "b"]
anyToArray("String value"); // ["String value"]anyToBoolean(value)
Converts a value to boolean based on predefined truthy values:
"true", "on", "enabled", "1", 1, and true.
anyToBoolean("true"); // true
anyToBoolean("on"); // true
anyToBoolean("enabled"); // true
anyToBoolean("1"); // true
anyToBoolean(1); // true
anyToBoolean(true); // true
anyToBoolean(null); // false
anyToBoolean("false"); // false
anyToBoolean(false); // false
anyToBoolean("Any string"); // falseanyToDate(value, defaultDate?)
Converts any input value into a valid Date instance.
If conversion is not possible, the provided defaultDate is returned (or new Date() by default).
Conversion rules:
stringornumber→ converted vianew Date(value)- valid
Dateinstance → returned as-is - anything else → returns
defaultDate
anyToDate("2025-05-01"); // Date("2025-05-01T00:00:00.000Z")
anyToDate(1700000000000); // Date from timestamp
anyToDate(new Date("2024-01-01")); // same Date instance
anyToDate("invalid"); // returns default Date (now)
anyToDate(null); // returns default Date (now)
anyToDate({}, new Date("2000-01-01")); // returns provided fallback dateflatObject(object)
Flattens a nested plain object into a single-level object with dot-separated keys. Only plain objects are flattened recursively. Arrays and other non-plain values are kept unchanged.
flatObject({
user: {
name: "Alice",
address: {
city: "London",
zip: 12345,
},
},
active: true,
});
// {
// "user.name": "Alice",
// "user.address.city": "London",
// "user.address.zip": 12345,
// active: true
// }
flatObject({
ids: [1, 2, 3],
meta: { count: 3 },
});
// {
// ids: [1, 2, 3],
// "meta.count": 3
// }mergeAndFlatObjects(...objects)
Merges multiple plain objects into one result and flattens nested objects into dot-separated keys. Each input object is flattened with flatObject() and then merged into a single output object. Keys from later arguments override earlier ones when the same path is repeated.
mergeAndFlatObjects(
{
user: {
name: "Alice",
active: true,
},
},
{
user: {
address: {
city: "London",
},
},
meta: { count: 3 },
}
);
// {
// "user.name": "Alice",
// "user.active": true,
// "user.address.city": "London",
// "meta.count": 3
// }createArray(length, getItem?)
Creates an array of the specified length. Optionally fills it using a callback function.
createArray(5); // [0, 1, 2, 3, 4]
createArray(6, i => i * 2); // [0, 2, 4, 6, 8, 10]
createArray(0); // []
createArray(4, i => "Item " + i); // [Item 0, Item 1, Item 2, Item 3]
createArray(4, () => "item"); // [item, item, item, item]Types
CustomObjectKey<K, V>
Generic object with string, number, or symbol keys.
type CustomObjectKey<K, V> = Record<string | number | symbol, V>;CustomObject<V>
Generic string-keyed object.
type CustomObject<V> = Record<string, V>;SimpleObject
A simple string-object mapping.
type SimpleObject = Record<string, string>;MultiArray<T>
Recursive array type allowing nested arrays of any depth.
type MultiArray<T> = T[] | MultiArray<T>[];MultiObject<V>
Recursive object type allowing deeply nested key-value pairs.
type MultiObject<V> = { [key: string]: V | MultiObject<V> };Delta
A numeric delta value: -1, 0, or 1.
type Delta = -1 | 0 | 1;Nullable<V>
Represents a value that can either be of type V or explicitly null.
type Nullable<V> = V | null;Undefinable<V>
Represents a value that can either be of type V or undefined.
type Undefinable<V> = V | undefined;NotDefinable<V>
Represents a value that can either be of type V, null, or undefined.
type NotDefinable<V> = V | null | undefined;Enum
A helper type for enum-like objects and values.
type Enum<T> = T[keyof T];EnumValue<E extends Enum>
Extracts the union of all values from an enum-like object. Useful when you want to type a variable as one of the allowed enum values without manually listing them.
enum Status {
Active = "active",
Inactive = "inactive",
};
type StatusValue = EnumValue<typeof Status>;
// "active" | "inactive"
const current: StatusValue = "active"; // OK
// const wrong: StatusValue = "pending"; // ErrorEnumValues<E>
Returns enum values as a union of their original literal types and stringified forms.
enum Role {
Admin = "admin",
User = "user",
}
type RoleValues = EnumValues<typeof Role>;
// Role.Admin | Role.User | "admin" | "user"Example Usage
import { anyToFloat, anyToArray, anyToBoolean, createArray } from "@akb2/types-tools";
const num = anyToFloat("3.14159", 0, 2); // 3.14
const arr = anyToArray("a"); // ["a"]
const flag = anyToBoolean("on"); // true
const seq = createArray(3, i => i + 1); // [1, 2, 3]🧾 License
MIT © 2025 Andrei Kobelev (@akb2)
