Add more docs to types

micromark · May 31, 2021 · be0952e · be0952e
1 parent 5cde392
commit be0952e
Show file tree

Hide file tree

Showing 8 changed files with 229 additions and 71 deletions.
diff --git a/packages/micromark-factory-destination/readme.md b/packages/micromark-factory-destination/readme.md
@@ -77,11 +77,11 @@ There is no default export.
 *   `effects` (`Effects`) — Context
 *   `ok` (`State`) — State switched to when successful
 *   `nok` (`State`) — State switched to when not successful
-*   `type` (`Type`) — Token type for whole (`<a>` or `b`)
-*   `literalType` (`Type`) — Token type when enclosed (`<a>`)
-*   `literalMarkerType` (`Type`) — Token type for enclosing (`<` and `>`)
-*   `rawType` (`Type`) — Token type when not enclosed (`b`)
-*   `stringType` (`Type`) — Token type for the URI (`a` or `b`)
+*   `type` (`string`) — Token type for whole (`<a>` or `b`)
+*   `literalType` (`string`) — Token type when enclosed (`<a>`)
+*   `literalMarkerType` (`string`) — Token type for enclosing (`<` and `>`)
+*   `rawType` (`string`) — Token type when not enclosed (`b`)
+*   `stringType` (`string`) — Token type for the URI (`a` or `b`)
 *   `max` (`number`, default: `Infinity`) — Max depth of nested parens
 
 ###### Returns

diff --git a/packages/micromark-factory-label/readme.md b/packages/micromark-factory-label/readme.md
@@ -77,9 +77,9 @@ Note that labels in markdown are capped at 999 characters in the string.
 *   `effects` (`Effects`) — Context
 *   `ok` (`State`) — State switched to when successful
 *   `nok` (`State`) — State switched to when not successful
-*   `type` (`Type`) — Token type for whole (`[a]`)
-*   `markerType` (`Type`) — Token type for the markers (`[` and `]`)
-*   `stringType` (`Type`) — Token type for the identifier (`a`)
+*   `type` (`string`) — Token type for whole (`[a]`)
+*   `markerType` (`string`) — Token type for the markers (`[` and `]`)
+*   `stringType` (`string`) — Token type for the identifier (`a`)
 
 ###### Returns
 

diff --git a/packages/micromark-factory-space/readme.md b/packages/micromark-factory-space/readme.md
@@ -78,7 +78,7 @@ Note that there is no `nok` parameter:
 
 *   `effects` (`Effects`) — Context
 *   `ok` (`State`) — State switched to when successful
-*   `type` (`Type`) — Token type for whole (`' \t'`)
+*   `type` (`string`) — Token type for whole (`' \t'`)
 *   `max` (`number`, default: `Infinity`) — Max size of whitespace
 
 ###### Returns

diff --git a/packages/micromark-factory-title/readme.md b/packages/micromark-factory-title/readme.md
@@ -78,9 +78,10 @@ There is no default export.
 *   `effects` (`Effects`) — Context
 *   `ok` (`State`) — State switched to when successful
 *   `nok` (`State`) — State switched to when not successful
-*   `type` (`Type`) — Token type for whole (`"a"`, `'b'`, `(c)`)
-*   `markerType` (`Type`) — Token type for the markers (`"`, `'`, `(`, and `)`)
-*   `stringType` (`Type`) — Token type for the value (`a`)
+*   `type` (`string`) — Token type for whole (`"a"`, `'b'`, `(c)`)
+*   `markerType` (`string`) — Token type for the markers (`"`, `'`, `(`, and
+    `)`)
+*   `stringType` (`string`) — Token type for the value (`a`)
 
 ###### Returns