nyxblabs / typiqus

🔤 Empower your type handling with uniqueness and customization. Effortlessly create and manage tailored types for a robust and flexible codebase. 🚀

🧬 Typiqus

🔤 Empower your type handling with uniqueness and customization. Effortlessly create and manage tailored types for a robust and flexible codebase. 🚀

▶️ Check online playground

💾 Install

# nyxi
nyxi add typiqus

# pnpm
pnpm add typiqus

# npm
npm i typiqus

# yarn
yarn add typiqus

📚 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 'typiqus'

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 'typiqus'

const types = generateTypes(await resolveSchema(defaultPlanet))

🔍 Output:

interface Typiqus {
   /** @default "earth" */
  name: string,

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

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

📄 generateMarkdown

import { resolveSchema, generateMarkdown } from 'typiqus'

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 nyxi
• 🏃 Run interactive tests using nyxr dev
• 🏃 Run nyxr web to start playground website
• 🏃 Run pnpm test before push to ensure all tests and lint checks passing

📜 License

MIT - Made with 💞