UNPKG

data-to-jsonschema-to-ts

Version:

Convert plain javascript objects to JSON Schema and TypeScript typings

18 lines 933 B
import { type TypescriptConverterOpts } from "ajsc"; import type { JsonSchema } from "../generate-schema/index.js"; export type GeneratedTypescript = string; export type { TypescriptConverterOpts }; /** * Convert a JSON Schema to TypeScript type declarations. * * Thin wrapper over [`ajsc`](https://www.npmjs.com/package/ajsc)'s * `TypescriptConverter`. The schema's `title` becomes the root type name. * Object types are emitted as `export type` aliases (use `inlineTypes: true` * to inline them instead). * * @param schema - The JSON Schema to convert. Must have a `title`. * @param opts - ajsc converter options (`inlineTypes`, `enumStyle`, `arrayItemNaming`, `depluralize`, `uncountableWords`, `jsdoc`). * @returns The generated TypeScript source as a string. */ export declare function convertJsonSchemaToTs(schema: JsonSchema, opts?: TypescriptConverterOpts): GeneratedTypescript; //# sourceMappingURL=index.d.ts.map