chore(index): improve OptionDetails type (#415)

Fdawgs · Feb 6, 2025 · c2485f9 · c2485f9
1 parent 7659827
commit c2485f9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/API.md b/API.md
@@ -86,7 +86,7 @@ UnRTF will use the directory of the original file to store embedded pictures.
 | Name | Type | Description |
 | --- | --- | --- |
 | arg | <code>string</code> | The argument to pass to the binary. |
-| type | <code>string</code> | The type of the option (`boolean`, `string`, etc). |
+| type | <code>&#x27;boolean&#x27;</code> \| <code>&#x27;number&#x27;</code> \| <code>&#x27;string&#x27;</code> | The type of the option. |
 | minVersion | <code>string</code> | The minimum version of the binary that supports this option. |
 | [maxVersion] | <code>string</code> | The maximum version of the binary that supports this option (optional). |
 

diff --git a/src/index.js b/src/index.js
@@ -18,7 +18,7 @@ const unrtfVersionRegex = /^(\d{1,2}\.\d{1,2}\.\d{1,2})/u;
 /**
  * @typedef {object} OptionDetails
  * @property {string} arg The argument to pass to the binary.
- * @property {string} type The type of the option (`boolean`, `string`, etc).
+ * @property {('boolean'|'number'|'string')} type The type of the option.
  * @property {string} minVersion The minimum version of the binary that supports this option.
  * @property {string} [maxVersion] The maximum version of the binary that supports this option (optional).
  */