untyped - npm Package Compare versions

Comparing version 0.2.9 to 0.2.10

dist/untyped.d.ts

@@ -5,3 +5,3 @@ declare type JSValue = string | number | bigint | boolean | symbol | Function | Array<any> | undefined | object | null;
 interface TypeDescriptor {
-    type?: JSType | JSType[];
+    type?: JSType | JSType[] | string | string[];
     items?: TypeDescriptor | TypeDescriptor[];
@@ -8,0 +8,0 @@ }

package.json

 {
   "name": "untyped",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "description": "",
@@ -5,0 +5,0 @@ "repository": "unjs/untyped",

README.md

@@ -95,3 +95,3 @@ # untyped
 ```js
-import { resolveSchema } from 'untyped'
+import { resolveSchema, generateTypes } from 'untyped'
 
@@ -121,2 +121,31 @@ const types = generateTypes(resolveSchema(defaultPlanet))
 
+### Generating markdown
+
+
+```js
+import { resolveSchema, generateTypes, generateMarkdown } from 'untyped'
+
+const markdown = generateMarkdown(generateTypes(resolveSchema(defaultPlanet)))
+```
+
+Output:
+
+```markdown
+# `name`
+- **Type**: `string`
+- **Default**: `"earth"`
+
+
+# `specs`
+
+## `gravity`
+- **Type**: `number`
+- **Default**: `9.8`
+
+
+## `moons`
+- **Type**: `array`
+- **Default**: `["moon"]`
+```
+
 ## Contribution
@@ -123,0 +152,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Lines of code

36043

increased by0.16%

Number of lines in readme file

177

increased by19.59%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

3123502

decreased by-0.07%

Number of package files

8

decreased by-11.11%

No dependency changes