docs: added the potential type description

kurone-kito · Jun 4, 2021 · 4d2a1d2 · 4d2a1d2
1 parent 16a6b97
commit 4d2a1d2
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/packages/dantalion-core/README.md b/packages/dantalion-core/README.md
@@ -420,7 +420,7 @@ type Position = 'adjust' | 'brain' | 'direct' | 'quick';
 
 ### `Potential`
 
-The types for potential.
+The potential type definition that can exert when taking action.
 
 ```ts
 type Potential =
@@ -436,7 +436,18 @@ type Potential =
   | 'No';
 ```
 
-_I'm not familiar with it yet._
+| key  | CC  | Value                                                                                        |
+| :--- | :-- | :------------------------------------------------------------------------------------------- |
+| `Ci` | _j_ | This type of person is good at sublimating existing works with respect.                      |
+| `Co` | _i_ | This type of person is skilled at exploring one thing. They also tend to an originator.      |
+| `Ei` | _d_ | This type of person is good at non-verbal and passive expression.                            |
+| `Eo` | _c_ | This type of person is skilled at active expression through words.                           |
+| `Fi` | _f_ | This type of person is relatively cautious and can see the meaning behind the numbers.       |
+| `Fo` | _e_ | This type of person is good at using numbers and other evidence-based expressions.           |
+| `Ii` | _b_ | This type of person is a good listener and can draw out the other person's point.            |
+| `Io` | _a_ | This type of person is good at active and aggressive communication.                          |
+| `Ni` | _h_ | This type of person has fine self-management skills and is good at maintaining organization. |
+| `No` | _g_ | This type of person is very caring and good at developing organizations.                     |
 
 ### `Response`
 

diff --git a/packages/dantalion-core/src/types/potential.ts b/packages/dantalion-core/src/types/potential.ts
@@ -1,7 +1,18 @@
 /**
- * The types for potential.
+ * The potential type definition that can exert when taking action.
  *
- * _I'm not familiar with it yet._
+ * | key  | CC  | Value                                                                                        |
+ * | :--- | :-- | :------------------------------------------------------------------------------------------- |
+ * | `Ci` | _j_ | This type of person is good at sublimating existing works with respect.                      |
+ * | `Co` | _i_ | This type of person is skilled at exploring one thing. They also tend to an originator.      |
+ * | `Ei` | _d_ | This type of person is good at non-verbal and passive expression.                            |
+ * | `Eo` | _c_ | This type of person is skilled at active expression through words.                           |
+ * | `Fi` | _f_ | This type of person is relatively cautious and can see the meaning behind the numbers.       |
+ * | `Fo` | _e_ | This type of person is good at using numbers and other evidence-based expressions.           |
+ * | `Ii` | _b_ | This type of person is a good listener and can draw out the other person's point.            |
+ * | `Io` | _a_ | This type of person is good at active and aggressive communication.                          |
+ * | `Ni` | _h_ | This type of person has fine self-management skills and is good at maintaining organization. |
+ * | `No` | _g_ | This type of person is very caring and good at developing organizations.                     |
  */
 export type Potential =
   | 'Ci'