Merge pull request #6 from oshx/chore/readme

Modified examples with 'typeof' operator.
Updated a version.
Split the code blocks in README.md.

README.md

@@ -23,16 +23,22 @@ Please add below in `tsconfig.json` file.
 
 ```typescript
 type ObjectKey
-    // explicit constant object keys
+  // explicit constant object keys
+```
 
+```typescript
 type ObjectValue
-    // explicit constant object values
+  // explicit constant object values
+```
 
+```typescript
 type PropsWithClassName
-    // extendable interface-like-type with optional property 'className'
+  // extendable interface-like-type with optional property 'className'
+```
 
+```typescript
 type AnyFunction
-    // simply declared any function
+  // simply declared any function
 ```
 
 ## Why it comes for?
@@ -78,6 +84,7 @@ export const ObjectA = {
   KEY_A: 'valueA',
   KEY_B: 'valueB',
 } as const;
+// Same effects with Enum type!
 
 export type ObjectAKey = ObjectKey<typeof ObjectA>;
 export type ObjectAValue = ObjectValue<typeof ObjectA>;
@@ -86,7 +93,7 @@ export type ObjectAValue = ObjectValue<typeof ObjectA>;
 const shouldBeKeyOfA: ObjectAKey = 'KeyA';
 const shouldBeValueOfA: ObjectAValue = 'ValueA';
 
-// Passed!
+// Passed ✔️
 const keyOfA: ObjectAKey = 'KEY_A';
 const valueOfA: ObjectAValue = 'valueA';
 ```

index.d.ts

@@ -6,7 +6,7 @@
  *   KEY_B: 'valueB',
  * } as const;
  *
- * type ObjectKey<ObjectA> = 'KEY_A'|'KEY_B';
+ * type ObjectKey<typeof ObjectA> = 'KEY_A'|'KEY_B';
  */
 
 declare type ObjectKey<T extends object = any> = keyof T
@@ -19,7 +19,7 @@ declare type ObjectKey<T extends object = any> = keyof T
  *   KEY_B: 'valueB',
  * } as const;
  *
- * type ObjectValue<ObjectA> = 'valueA'|'valueB';
+ * type ObjectValue<typeof ObjectA> = 'valueA'|'valueB';
  */
 declare type ObjectValue<T extends object = any> = T[ObjectKey<T>]
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oshx/type-helper",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Types help TypeScript types.",
   "repository": {
     "type": "git",