untyped

Generate types and markdown from a config object.

Types
unjs/untypeduntyped.unjs.io/untyped

README

untyped


▶️ Check online playground

Install


  1. ```sh
  2. # npm
  3. npm i untyped

  5. # yarn
  6. yarn add untyped

  8. # pnpm
  9. pnpm add untyped
  10. ```

Usage


First we have to define a reference object that describes types, defaults, and a $resolve method (normalizer).

  1. ```js
  2. const defaultPlanet = {
  3.   name: "earth",
  4.   specs: {
  5.     gravity: {
  6.       $resolve: (val) => parseFloat(val),
  7.       $default: "9.8",
  8.     },
  9.     moons: {
  10.       $resolve: (val = ["moon"]) => [].concat(val),
  11.       $schema: {
  12.         title: "planet moons",
  13.       },
  14.     },
  15.   },
  16. };
  17. ```

API


resolveSchema


  1. ```js
  2. import { resolveSchema } from "untyped";

  4. const schema = await resolveSchema(defaultPlanet);
  5. ```

Output:

  1. ```json
  2. {
  3.   "properties": {
  4.     "name": {
  5.       "type": "string",
  6.       "default": "earth"
  7.     },
  8.     "specs": {
  9.       "properties": {
  10.         "gravity": {
  11.           "default": 9.8,
  12.           "type": "number"
  13.         },
  14.         "moons": {
  15.           "title": "planet moons",
  16.           "default": ["moon"],
  17.           "type": "array",
  18.           "items": [
  19.             {
  20.               "type": "string"
  21.             }
  22.           ]
  23.         }
  24.       },
  25.       "type": "object"
  26.     }
  27.   },
  28.   "type": "object"
  29. }
  30. ```

generateTypes


  1. ```js
  2. import { resolveSchema, generateTypes } from "untyped";

  4. const types = generateTypes(await resolveSchema(defaultPlanet));
  5. ```

Output:

  1. ```ts
  2. interface Untyped {
  3.   /** @default "earth" */
  4.   name: string;

  6.   specs: {
  7.     /** @default 9.8 */
  8.     gravity: number;

  10.     /**
  11.      * planet moons
  12.      * @default ["moon"]
  13.      */
  14.     moons: string[];
  15.   };
  16. }
  17. ```

generateMarkdown


  1. ```js
  2. import { resolveSchema, generateMarkdown } from "untyped";

  4. const markdown = generateMarkdown(await resolveSchema(defaultPlanet));
  5. ```

Output:

  1. ```markdown
  2. # `name`

  4. - **Type**: `string`
  5. - **Default**: `"earth"`

  7. # `specs`

  9. ## `gravity`

  11. - **Type**: `number`
  12. - **Default**: `9.8`

  14. ## `moons`

  16. - **Type**: `array`
  17. - **Default**: `["moon"]`
  18. ```

💻 Development


- Clone this repository
- Enable Corepack usingcorepack enable (use npm i -g corepack for Node.js < 16.10)
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev
- Use pnpm web to start playground website
- Use pnpm test before push to ensure all tests and lint checks passing

License


Thanks to @dominikschreiber for donating package name.