type-genius
Advanced tools
Comparing version 0.0.12 to 0.0.13
{ | ||
"name": "type-genius", | ||
"version": "0.0.12", | ||
"version": "0.0.13", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
# Type Genius | ||
[Demo](https://type-genius.carbonology.in/) | ||
## What is it | ||
@@ -32,14 +34,14 @@ | ||
| **Option Name** | **Type** | **Default** | **Description** | | ||
|---|---|---|---| | ||
| customTypes | Object? | ```js { string: "string", number: "number", boolean: "boolean", object: "object" } ``` | Customize the types that get rendered. For objects, you can render a Record like this: ```js customTypes: { object: "Record<string, unknown>" ``` | | ||
| forceOptional | Boolean? | false | Forces each value in every type to be optional. | | ||
| initialInterfaceName | String? | "Response" | The name given to the first generated interface. | | ||
| logSuccess | Boolean? | false | Should a success message get rendered after successfully generating the types. | | ||
| outputFilename | String? | "exported.d.ts" | File name to give the rendered types file. | | ||
| outputPath | String? | "../dist/" | Where to render the generated types. | | ||
| renderSemis | Boolean? | false | Render semicolons in the outputted file. | | ||
| skipFileWrite | Boolean? | false | Whether to write the file or not. | | ||
| useStore | TypeStore? | [] | Store of existing InterfaceConfiguration objects to use for this generation. | | ||
| useTypes | Boolean? | false | Whether to render "type"s instead of "interface"s. | | ||
| **Option Name** | **Type** | **Default** | **Description** | | ||
| -------------------- | ---------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| customTypes | Object? | `js { string: "string", number: "number", boolean: "boolean", object: "object" } ` | Customize the types that get rendered. For objects, you can render a Record like this: `js customTypes: { object: "Record<string, unknown>" ` | | ||
| forceOptional | Boolean? | false | Forces each value in every type to be optional. | | ||
| initialInterfaceName | String? | "Response" | The name given to the first generated interface. | | ||
| logSuccess | Boolean? | false | Should a success message get rendered after successfully generating the types. | | ||
| outputFilename | String? | "exported.d.ts" | File name to give the rendered types file. | | ||
| outputPath | String? | "../dist/" | Where to render the generated types. | | ||
| renderSemis | Boolean? | false | Render semicolons in the outputted file. | | ||
| skipFileWrite | Boolean? | false | Whether to write the file or not. | | ||
| useStore | TypeStore? | [] | Store of existing InterfaceConfiguration objects to use for this generation. | | ||
| useTypes | Boolean? | false | Whether to render "type"s instead of "interface"s. | | ||
@@ -46,0 +48,0 @@ ## Architecture |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
22498
160