Skip to content

Commit b0f2854

Browse files
theotongetheotonge
committed
docs: fix generateType description in readme
1 parent 17abd2c commit b0f2854

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
![npms.io (final)](https://img.shields.io/npms-io/maintenance-score/svg-to-ts) ![GitHub Workflow](https://img.shields.io/github/workflow/status/kreuzerk/svg-to-ts/release) ![GitHub](https://img.shields.io/github/license/kreuzerk/svg-to-ts) ![npm](https://img.shields.io/npm/v/svg-to-ts)
88

99
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
10+
1011
[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors-)
12+
1113
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1214

1315
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -252,7 +254,7 @@ accepts an object with the filename as key and the svg data as key.
252254
| outputDirectory | string | "./dist" | name of the output directory |
253255
| objectName | string | default - export | name of the exported const - if nothing is set - default export will be used |
254256
| verbose | boolean | false | defines if the log should contain additional information. Can be useful for debugging |
255-
| generateType | boolean | true | defines if it's needed to generate type |
257+
| generateType | boolean | true | defines if a type should be generated |
256258
| typeName | string | MyIconType | name of the type to be used when `generateType` is set to `true` |
257259
| namePrefix | string | | prefix to be used for the name property included in the generated constant |
258260

@@ -295,9 +297,9 @@ Only the icons included in the consuming SPA also end up in the final bundle of
295297

296298
| --version | type | default | description |
297299
| --------------------- | -------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------- |
298-
| typeName | string | myIcons | name of the generated type |
299300
| tsx | boolean | false | Generate TSX file which can be used as React components out of the box |
300-
| generateType | boolean | false | prevent generating enumeration type |
301+
| generateType | boolean | false | defines if a type should be generated |
302+
| typeName | string | myIcons | name of the type to be used when `generateType` is set to `true` |
301303
| generateTypeObject | boolean | false | generate type object |
302304
| generateEnum | boolean | false | generate enum object |
303305
| prefix | string | myIcon | prefix for the generated svg constants |
@@ -389,8 +391,8 @@ end up there.
389391
| ------------------------- | -------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
390392
| barrelFileName | string | index | name of the generated type |
391393
| tsx | boolean | false | Generate TSX file which can be used as React components out of the box |
392-
| typeName | string | myIcons | name of the generated type |
393-
| generateType | boolean | false | prevent generating enumeration type |
394+
| generateType | boolean | false | defines if a type should be generated |
395+
| typeName | string | myIcons | name of the type to be used when `generateType` is set to `true` |
394396
| generateTypeObject | boolean | false | generate type object |
395397
| generateEnum | boolean | false | generate enum object |
396398
| exportCompleteIconSet | boolean | false | Specifies if the complete icon set should be exported or not (can be very handy for showcases) |

0 commit comments

Comments
 (0)