untyped

untyped

▶️ Check online playground

Install

# npm
npm i untyped

# yarn
yarn add untyped

# pnpm
pnpm add untyped

Usage

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

const defaultPlanet = {
  name: "earth",
  specs: {
    gravity: {
      $resolve: (val) => parseFloat(val),
      $default: "9.8",
    },
    moons: {
      $resolve: (val = ["moon"]) => [].concat(val),
      $schema: {
        title: "planet moons",
      },
    },
  },
};

API

resolveSchema

import { resolveSchema } from "untyped";

const schema = await resolveSchema(defaultPlanet);

Output:

{
  "properties": {
    "name": {
      "type": "string",
      "default": "earth"
    },
    "specs": {
      "properties": {
        "gravity": {
          "default": 9.8,
          "type": "number"
        },
        "moons": {
          "title": "planet moons",
          "default": ["moon"],
          "type": "array",
          "items": [
            {
              "type": "string"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

generateTypes

import { resolveSchema, generateTypes } from "untyped";

const types = generateTypes(await resolveSchema(defaultPlanet));

Output:

interface Untyped {
  /** @default "earth" */
  name: string;

  specs: {
    /** @default 9.8 */
    gravity: number;

    /**
     * planet moons
     * @default ["moon"]
     */
    moons: string[];
  };
}

generateMarkdown

import { resolveSchema, generateMarkdown } from "untyped";

const markdown = generateMarkdown(await resolveSchema(defaultPlanet));

Output:

# `name`

- **Type**: `string`
- **Default**: `"earth"`

# `specs`

## `gravity`

- **Type**: `number`
- **Default**: `9.8`

## `moons`

- **Type**: `array`
- **Default**: `["moon"]`

💻 Development

• Clone this repository
• Enable Corepack using corepack 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

MIT

Thanks to @dominikschreiber for donating package name.

Changelog

v1.4.1

compare changes

🩹 Fixes

• Make sure leading comments has value before assigning (7a94141)

📦 Build

• Add new ts type exports (1038f03)

🌊 Types

• Improve types for $resolve function (#97)

🏡 Chore

• Update badge (#109)
• Update dependencies (ef3250b)
• Use node 18 (b11fabd)
• Update dependencies (af9dedf)
• Lint (0036975)
• Update snapshots with vitest 1.x (6ca444f)
• Update ci script (f5feaa4)
• web: Update marked (f2a4439)
• Update types (4683cae)
• Prettier ignore web/.output (046ef3b)

✅ Tests

• Add test for loader (5388749)

🎨 Styles

• Lint with prettier v3 (3292277)
• Format with prettier v3 (4aefefe)

🤖 CI

• Enable & use conventional commit for autofix (#104)

❤️ Contributors

• Pooya Parsa (@pi0)
• Daniel Roe [e-mail]
• Luke Nelson [e-mail]