![\"logo\"](\"./logo.png\"){kind=logo}
\n\n \n
\n Zod To Typescript\n
\n\n\n`@duplojs/zod-to-typescript` is a library that converts Zod schemas to TypeScript types.\n\n## Installation\n\nTo consume `@duplojs/zod-to-typescript`, you need to install the npm package and zod.\n```bash\nnpm install @duplojs/zod-to-typescript zod\n```\n\n## Usage\n\n### 1. Import necessary modules\n\n```ts\nimport { z as zod } from 'zod';\nimport { ZodToTypescript } from '@duplojs/zod-to-typescript';\n```\n\n### 2. Define Zod schema\n\nCreate a Zod schema that you want to convert to TypeScript:\n```ts\nconst schema = zod.object({\n name: zod.string(),\n age: zod.number(),\n isStudent: zod.boolean(),\n});\n```\n\n### 3. Convert Zod schema to TypeScript type\n\nUse the `convert` method of `ZodToTypescript` to convert the Zod schema to a TypeScript type declaration:\n```ts\nconst options: ConvertOptions = {\n name: \"User\", // Optional: Specify a name for the TypeScript type\n export: true, // Optional: Export the TypeScript type\n};\n\nconst tsType = ZodToTypescript.convert(userSchema, options);\n```\n\n### 4. Output the TypeScript type\n\nThe `convert` method returns a string containing the TypeScript type declaration. You can output this string to a file or use it directly in your code:\n```ts\nconsole.log(tsType);\n// output:\nexport type User = {\n name: string;\n age: number;\n isStudent: boolean;\n};\n```\n\n### 5. Full Example\n\n```ts\nimport { z as zod } from 'zod';\nimport { ZodToTypescript } from '@duplojs/zod-to-typescript';\n\nconst schema = zod.object({\n name: zod.string(),\n age: zod.number(),\n isStudent: zod.boolean(),\n});\n\nconst options: ConvertOptions = {\n name: \"User\",\n export: true,\n};\n\nconst tsType = ZodToTypescript.convert(schema, options);\n\nconsole.log(tsType);\n// Output: \nexport type User = { \n name: string; \n age: number; \n isStudent: boolean; \n};\n```\n\n### 6. Using Identifiers\n\nIdentifiers allow you to give a name to a schema. You can also use a schema directly as an identifier. This can be useful when you have nested schemas and want to refer to them by name.\n\n```ts\nimport { ZodToTypescript, ConvertOptions } from \"@duplojs/zod-to-typescript\";\nimport { z as zod } from \"zod\";\n\n// Define your schemas\nconst addressSchema = zod.object({\n street: zod.string(),\n city: zod.string(),\n zipCode: zod.string(),\n});\n\nconst companySchema = zod.object({\n name: zod.string(),\n address: addressSchema,\n}).identifier(\"Company\"); // automatically identifies the schema as \"Company\"\n\nconst employeeSchema = zod.object({\n employeeId: zod.number(),\n name: zod.string(),\n position: zod.string(),\n company: companySchema,\n})\n\n// Convert the Employee schema to TypeScript\nconst options: ConvertOptions = {\n name: \"Employee\",\n identifiers: [\n {\n name: \"Address\", // define manually\n zodSchema: addressSchema,\n },\n ],\n export: true,\n};\n\nconst tsType = ZodToTypescript.convert(employeeSchema, options);\n\nconsole.log(tsType);\n// Output:\nexport type Address = {\n street: string;\n city: string;\n zipCode: string;\n};\n\nexport type Company = {\n name: string;\n address: Address;\n};\n\nexport type Employee = {\n employeeId: number;\n name: string;\n position: string;\n company: Company;\n};\n```\n\n### 7. Recursive Schemas\n\nRecursive schemas allow you to define schemas that reference themselves. This is useful for defining structures like trees or linked lists. You can use `zod.lazy()` to create recursive schemas.\n\n```ts\nimport { ZodToTypescript, ConvertOptions } from \"@duplojs/zod-to-typescript\";\nimport { z as zod } from \"zod\";\n\nconst categorySchema = zod.object({\n name: zod.string(),\n subcategories: zod.lazy(() => categorySchema.array()),\n}).identifier(\"Category\");\n\nconst tsType = ZodToTypescript.convert(categorySchema, { export: true });\n\nconsole.log(tsType);\n// Output:\nexport type Category = {\n name: string;\n subcategories: Category[];\n};\n```\n\n### 8. New instance\nYou can create instance of `ZodToTypescript` to make an environment types.\n\n```ts\nimport { ZodToTypescript } from \"@duplojs/zod-to-typescript\";\nimport { z as zod } from \"zod\";\n\nconst commentSchema = zod.object({\n user: zod.lazy
\n ![\"lang\"](\"https://img.shields.io/badge/coverage-100%25-green?style=plastic\"){kind=icon}
\n ![\"lang\"](\"https://img.shields.io/npm/v/@duplojs/zod-to-typescript\")
\n