@sohanemon/utils 5.0.1 → 5.0.3

package/dist/functions/index.d.ts

@@ -209,3 +209,14 @@ export declare const mergeRefs: MergeRefs;
  * @example goToClientSideHash('my-element');
  */
 export declare function goToClientSideHash(id: string, opts?: ScrollIntoViewOptions): void;
+/**
+ * Escapes a string for use in a regular expression.
+ *
+ * @param str - The string to escape
+ * @returns - The escaped string
+ *
+ * @example
+ * const escapedString = escapeRegExp('Hello, world!');
+ * // escapedString === 'Hello\\, world!'
+ */
+export declare function escapeRegExp(str: string): string;

package/dist/functions/index.js

@@ -374,3 +374,16 @@ export function goToClientSideHash(id, opts) {
     el.scrollIntoView({ behavior: 'smooth', block: 'start', ...opts });
     window.history.pushState(null, '', `#${id}`);
 }
+/**
+ * Escapes a string for use in a regular expression.
+ *
+ * @param str - The string to escape
+ * @returns - The escaped string
+ *
+ * @example
+ * const escapedString = escapeRegExp('Hello, world!');
+ * // escapedString === 'Hello\\, world!'
+ */
+export function escapeRegExp(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}

package/dist/types/guards.d.ts

@@ -1,6 +1,5 @@
 export type Primitive = string | number | bigint | boolean | symbol | null | undefined;
 export type Falsy = false | '' | 0 | null | undefined;
-export type Nullish = null | undefined;
 export declare const isFalsy: (val: unknown) => val is Falsy;
-export declare const isNullish: (val: unknown) => val is Nullish;
+export declare const isNullish: (val: unknown) => val is (null | undefined);
 export declare const isPrimitive: (val: unknown) => val is Primitive;

package/dist/types/utilities.d.ts

@@ -10,6 +10,18 @@ export type DeepRequired<T> = T extends Function ? T : T extends Array<infer U>
 export type Never<T> = {
     [K in keyof T]: never;
 };
+export type Nullable<T> = T extends object ? {
+    [P in keyof T]: Nullable<T[P]>;
+} : T | null;
+export type Optional<T> = T extends object ? {
+    [P in keyof T]: Optional<T[P]>;
+} : T | undefined;
+export type Nullish<T> = T extends object ? {
+    [P in keyof T]: Nullish<T[P]>;
+} : T | null | undefined;
+export type Maybe<T> = T extends object ? {
+    [P in keyof T]?: Nullish<T[P]>;
+} : T | null | undefined;
 export type DeepReadonly<T> = T extends Function ? T : T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends object ? {
     readonly [K in keyof T]: DeepReadonly<T[K]>;
 } : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sohanemon/utils",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "author": "Sohan Emon <sohanemon@outlook.com>",
   "description": "",
   "type": "module",