Skip to content

Commit c2485f9

Browse files
authored
chore(index): improve OptionDetails type (#415)
1 parent 7659827 commit c2485f9

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ UnRTF will use the directory of the original file to store embedded pictures.
8686
| Name | Type | Description |
8787
| --- | --- | --- |
8888
| arg | <code>string</code> | The argument to pass to the binary. |
89-
| type | <code>string</code> | The type of the option (`boolean`, `string`, etc). |
89+
| type | <code>&#x27;boolean&#x27;</code> \| <code>&#x27;number&#x27;</code> \| <code>&#x27;string&#x27;</code> | The type of the option. |
9090
| minVersion | <code>string</code> | The minimum version of the binary that supports this option. |
9191
| [maxVersion] | <code>string</code> | The maximum version of the binary that supports this option (optional). |
9292

src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const unrtfVersionRegex = /^(\d{1,2}\.\d{1,2}\.\d{1,2})/u;
1818
/**
1919
* @typedef {object} OptionDetails
2020
* @property {string} arg The argument to pass to the binary.
21-
* @property {string} type The type of the option (`boolean`, `string`, etc).
21+
* @property {('boolean'|'number'|'string')} type The type of the option.
2222
* @property {string} minVersion The minimum version of the binary that supports this option.
2323
* @property {string} [maxVersion] The maximum version of the binary that supports this option (optional).
2424
*/

0 commit comments

Comments
 (0)