Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

typedoc-plugin-zod

Gerrit0104.7kMIT1.4.1

TypeDoc plugin which replaces z.infer<typeof x> with the inferred type

typedoc-plugin

readme

typedoc-plugin-zod

Improves display of types created with Zod's z.infer and z.input types.

Usage

npm install --save-dev typedoc-plugin-zod
// typedoc.json
{
    "plugin": ["typedoc-plugin-zod"]
}

See an example of this plugin in action.

Change Log

See CHANGELOG.md

changelog

v1.4.1 (2025-03-12)

  • Fix broken type alias resolution with TypeDoc 0.28, #9.

v1.4.0 (2025-03-02)

  • Support TypeDoc 0.28

v1.3.1 (2024-12-14)

  • Fixed broken links to type properties for types created with this plugin, TypeStrong/typedoc#2808.

v1.3.0 (2024-11-24)

  • Support TypeDoc 0.27.

v1.2.1 (2024-08-18)

  • Fix warnings about referenced but not present reflections in packages mode, #6.
  • Copy comments from schema object declaration to type alias, #7.

v1.2.0 (2024-06-22)

  • Support TypeDoc 0.26.

v1.1.2 (2024-01-06)

  • Added support for the z.input type, #3.

v1.1.1 (2023-12-26)

  • Fixed conversion of symbols where the same name is used for a type and variable, #2.

v1.1.0 (2023-08-25)

  • Add support for TypeDoc 0.25.x

v1.0.2

  • Update peer dependency to allow TypeDoc 0.24

v1.0.1

  • Add GitHub links to NPM package