Change docs

Author: m-bock

README.md

@@ -1,8 +1,5 @@
 # purescript-ts-bridge
 
-<img
-src="https://media.tenor.com/MRCIli40TYoAAAAi/under-construction90s-90s.gif" width="30">
-
 A **PureScript** library for type class based **TypeScript** type generation (`.d.ts` files).
 
 ## Documentation
@@ -37,6 +34,6 @@ spago install ts-bridge
 
 # Support
 
-If you find a bug or have a feature idea feel free to make a PR or file an issue. Or just []()
+If you find a bug or have a feature idea feel free to make a PR or file an issue.
 
 <a href='https://ko-fi.com/C0C3HQFRF' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi4.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

docs/type-comparison.md

@@ -15,6 +15,7 @@
 - [Function](#function)
 - [Promise](#promise)
 - [Effect](#effect)
+- [Unit](#unit)
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 The following is a list of default implementations for types that are provided in this library. Since the generation typeclass is defined on your side, you can choose a subset of the provided implementations.
@@ -412,7 +413,7 @@ type Maybe<A> = {
     <td colspan=3>
       <h2>Either</h2>
 
-`Either` is represented as opaque type using TypeScript __branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.
+`Either` is represented as opaque type using TypeScript branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.
 
 </td>
   </tr>
@@ -481,7 +482,7 @@ type Either<A, B> = {
     <td colspan=3>
       <h2>Tuple</h2>
 
-`Tuple` is represented as opaque type using TypeScript __branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.
+`Tuple` is represented as opaque type using TypeScript branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.
 
 </td>
   </tr>
@@ -940,7 +941,70 @@ Effect a
 
 `~/Effect.purs`
 ```hs
-foreign import data Effect :: Type -> Type
+foreign import data Effect
+  :: Type -> Type
+```
+
+</td>
+<td valign="top">
+
+
+`<builtin>`
+
+
+  </td>
+</tr>
+<tr></tr>
+
+
+  <tr>
+    <td colspan=3>
+      <h2>Unit</h2>
+
+`Unit` is represented as TypeScript's `void`
+
+
+</td>
+  </tr>
+  <tr></tr>
+  <tr>
+    <th></th>
+    <th align="left">PureScript</th>
+    <th align="left">TypeScript</th>
+  </tr>
+  <tr></tr>
+
+
+<tr>
+  <td valign="top">Ref</td>
+  <td valign="top">
+
+```ts
+Unit
+```
+
+</td>
+<td valign="top">
+
+
+```ts
+void
+```
+
+
+  </td>
+</tr>
+<tr></tr>
+
+
+<tr>
+  <td valign="top">Def</td>
+  <td valign="top">
+
+`~/Data/Unit.purs`
+```hs
+foreign import data Unit
+  :: Type
 ```
 
 </td>

gen-docs/data.js

@@ -96,7 +96,7 @@ export const data = [
   ],
   [
     "Either",
-    "`Either` is represented as opaque type using TypeScript __branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.",
+    "`Either` is represented as opaque type using TypeScript branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.",
     [
       [
         "Ref",
@@ -128,7 +128,7 @@ export const data = [
   ],
   [
     "Tuple",
-    "`Tuple` is represented as opaque type using TypeScript __branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.",
+    "`Tuple` is represented as opaque type using TypeScript branded types. So there is no direct way to create a `Either` in TypeScript. See the FAQ for the general decision to represent ADTs as opaque types.",
     [
       [
         "Ref",
@@ -324,43 +324,37 @@ export const data = [
         [
           "~/Effect.purs",
           [
-            "foreign import data Effect :: Type -> Type",
+            "foreign import data Effect",
+            "  :: Type -> Type"
+          ].join("\n"),
+        ],
+        null,
+      ],
+    ],
+  ],
+  [
+    "Unit",
+    [
+      "`Unit` is represented as TypeScript's `void`",
+      "",
+    ].join("\n"),
+    [
+      [
+        "Ref",
+        ["Unit"].join("\n"),
+        ["void"].join("\n"),
+      ],
+      [
+        "Def",
+        [
+          "~/Data/Unit.purs",
+          [
+            "foreign import data Unit",
+            "  :: Type"
           ].join("\n"),
         ],
         null,
       ],
     ],
   ],
-  // [
-  //   "",
-  //   "",
-  //   [
-  //     ["Ref", "", ""],
-  //     ["Def", "", ""],
-  //   ],
-  // ],
-  // [
-  //   "",
-  //   "",
-  //   [
-  //     ["Ref", "", ""],
-  //     ["Def", "", ""],
-  //   ],
-  // ],
-  // [
-  //   "",
-  //   "",
-  //   [
-  //     ["Ref", "", ""],
-  //     ["Def", "", ""],
-  //   ],
-  // ],
-  // [
-  //   "",
-  //   "",
-  //   [
-  //     ["Ref", "", ""],
-  //     ["Def", "", ""],
-  //   ],
-  // ],
 ];