A collection of utility functions that I use across my JavaScript and TypeScript projects.
Run the following command to add @byjohann/utils to your project.
# npm
npm install -D @byjohann/utils
# pnpm
pnpm add -D @byjohann/utils
# yarn
yarn add -D @byjohann/utilsConverts MaybeArray<T> to Array<T>.
type MaybeArray<T> = T | T[]
declare function toArray<T>(array?: MaybeArray<T> | null | undefined): T[]Converts an array of objects to a comma-separated values (CSV) string that contains only the columns specified.
declare function createCSV<T extends Record<string, unknown>>(
data: T[],
columns: (keyof T)[],
options?: {
/** @default ',' */
delimiter?: string
/** @default true */
includeHeaders?: boolean
/** @default false */
quoteAll?: boolean
}
): stringEscapes a value for a CSV string.
Note
Returns an empty string if the value is null or undefined.
declare function escapeCSVValue(value: unknown): stringType-safe wrapper around JSON.stringify falling back to the original value if it is not a string or an error is thrown.
declare function tryParseJSON<T = unknown>(value: unknown): TClones the given JSON value.
Note
The value must not contain circular references as JSON does not support them. It also must contain JSON serializable values.
declare function cloneJSON<T>(value: T): TInterop helper for default exports.
declare function interopDefault<T>(m: T | Promise<T>): Promise<T extends {
default: infer U
} ? U : T>Example:
import { interopDefault } from '@byjohann/utils'
const mod = await interopDefault(import('./module.js'))Strictly typed Object.keys.
declare function objectKeys<T extends Record<any, any>>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>Strictly typed Object.entries.
declare function objectEntries<T extends Record<any, any>>(obj: T): Array<[keyof T, T[keyof T]]>Deeply applies a callback to every key-value pair in the given object, as well as nested objects and arrays.
declare function deepApply<T extends Record<any, any>>(data: T, callback: (item: T, key: keyof T, value: T[keyof T]) => void): voidAdds a leading slash to the given path if it does not already have one.
declare function withLeadingSlash(path?: string): stringRemoves the trailing slash from the given path if it has one.
declare function withoutTrailingSlash(path?: string): stringAdds a trailing slash to the given path if it does not already have one.
declare function withTrailingSlash(path?: string): stringJoins the given base URL and path, ensuring that there is only one slash between them.
declare function joinURL(base?: string, path?: string): stringRemoves the base path from the input path, if it is present.
declare function withoutBase(input?: string, base?: string): stringReturns the pathname of the given path, which is the path without the query string.
declare function getPathname(path?: string): stringSimple template engine to replace variables in a string.
declare function template(str: string, variables: Record<string | number, any>, fallback?: string | ((key: string) => string)): stringExample:
import { template } from '@byjohann/utils'
const str = 'Hello, {name}!'
const variables = { name: 'world' }
console.log(template(str, variables)) // Hello, world!Generates a random string.
declare function generateRandomId(size?: number, dict?: string): stringRemoves common leading whitespace from a template string while also removing empty lines at the beginning and end.
declare function unindent(str: TemplateStringsArray | string): stringMIT License © 2024-PRESENT Johann Schopplich