Merge pull request #5 from oshx/fix/rename

Renamed file for tsconfig.
Added a badge.
Removed the paths field.
Updated a version with applied file rename.

README.md

@@ -1,4 +1,6 @@
 # @oshx/type-helper
+[![Node.js Package](https://github.com/oshx/type-helper/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/oshx/type-helper/actions/workflows/npm-publish.yml)
+
 This package includes the practical type helper for TypeScript users.
 
 ## Installation
@@ -26,8 +28,8 @@ type ObjectKey
 type ObjectValue
     // explicit constant object values
 
-interface PropsWithClassName
-    // extendable interface with optional property 'className'
+type PropsWithClassName
+    // extendable interface-like-type with optional property 'className'
 
 type AnyFunction
     // simply declared any function

types.d.ts → index.d.ts

@@ -23,19 +23,19 @@ declare type ObjectKey<T extends object = any> = keyof T
  */
 declare type ObjectValue<T extends object = any> = T[ObjectKey<T>]
 
-/** The extendable interface for CSS-in-JS users.
+/** The extendable interface-like-type for CSS-in-JS users.
  *
  * @example
  * interface ReactComponentProps extends PropsWithChildren, PropsWithClassName {
  *   ...
  * }
  */
-declare interface PropsWithClassName<
+declare type PropsWithClassName<
   T extends object = object,
   ClassNameType = string | undefined
-> extends T {
+> = {
   className: ClassNameType
-}
+} & T
 
 /** The simple `Any function` declaration.
  *

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oshx/type-helper",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Types help TypeScript types.",
   "repository": {
     "type": "git",
@@ -13,12 +13,12 @@
   "exports": {
     ".": {
       "types": {
-        "default": "./types.d.ts"
+        "default": "./index.d.ts"
       }
     }
   },
-  "typeRoots": "./types.d.ts",
-  "types": "./types.d.ts",
+  "typeRoots": "./index.d.ts",
+  "types": "./index.d.ts",
   "author": {
     "name": "오승환",
     "email": "[email protected]",

tsconfig.json

@@ -6,7 +6,6 @@
     "rootDir": "./",
     "moduleResolution": "node",
     "baseUrl": "./",
-    "paths": {},
     "allowJs": true,
     "checkJs": true,
     "declaration": true,