Merge pull request #7 from oshx/update/optional-class-name

Updated README.md. Updated 'PropsWithClassName' type as an optional value. Updated versions.
oshx · Jul 21, 2024 · c59b620 · c59b620
2 parents 1ce750a + 42e96ad
commit c59b620
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,17 @@ $ npm i -D @oshx/type-helper
 
 Please add below in `tsconfig.json` file.
 ```json
+{
+  "compilerOptions": {
+    "typeRoots": [
+      "node_modules/@oshx"
+    ]
+  }
+}
+```
+
+If your TypeScript doesn't accept that type, then add below.
+```json
 {
   "compilerOptions": {
     "typeRoots": [

diff --git a/index.d.ts b/index.d.ts
@@ -32,9 +32,9 @@ declare type ObjectValue<T extends object = any> = T[ObjectKey<T>]
  */
 declare type PropsWithClassName<
   T extends object = object,
-  ClassNameType = string | undefined
+  ClassNameType = string
 > = {
-  className: ClassNameType
+  className?: ClassNameType
 } & T
 
 /** The simple `Any function` declaration.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oshx/type-helper",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Types help TypeScript types.",
   "repository": {
     "type": "git",