Skip to contentpackage
ts2schema
v1.2.0Generate JSON Schema from TypeScript exports
node any1 depscjstypesopen source
- license
- MIT
- deps
- 1
- unpacked
- 16.6 kB
- files
- 6
- node
- any
$npm install ts2schema@1.2.0 README
GitHub-flavored package documentation.
downloads
Across all versions.
Download trend unavailable.
compatibility
Runtime metadata.
versions
Latest published Dec 3, 2025
maintainers
Registry package owners.
contents
ts2schema
Generate JSON Schema from TypeScript exports
Installation
npm install ts2schema
Usage
// file.ts
export const testUserId = 123;
/** add number */
export const add = async (num1: number, num2?: number) => num1 + (num2 ?? 0);
/** say hi to user */
export const sayHi = (name: string) => `Hi, ${name}`;
export const makeUser = (user: {
/** Name of user */ name: string;
/** Age of user */ age?: number;
}) => user;
import { generateSchemas } from 'ts2schema';
const schemas = generateSchemas('absolute/path/to/your/file.ts');
console.log(schemas);
/* Logs:
{
nonFns: {
testUserId: {
type: 'number',
enum: [123],
$schema: 'http://json-schema.org/draft-07/schema#',
},
},
unaryFns: ['makeUser'],
fns: {
add: {
type: 'object',
properties: {
params: {
type: 'object',
properties: {
num1: { type: 'number', title: 'num1' },
num2: { type: 'number', title: 'num2' },
},
required: ['num1'],
},
The unaryFns values are to track the "flavor" of a function. Consider these functions which wind up with similar params schemas:
export const addV1 = (a: number, b: number) => a + b;
export const addV2 = ({ a, b }: { a: number; b: number }) => a + b;
export const sayHiV1 = (name: string) => `Hi, ${name}`;
export const sayHiV2 = ({ name }: { name: string }) => `Hi, ${name}`;
The unaryFns will be ['addV2', 'sayHiV2']. This let's us know how to invoke the functions. See this test for an example.
install size
Estimated unpacked size across 53 packages.
542.7 MB
Includes dependencies.
dependencies
1 direct · 1 outdated
result: { type: 'number' },
},
additionalProperties: false,
$schema: 'http://json-schema.org/draft-07/schema#',
},
makeUser: {
type: 'object',
properties: {
params: {
type: 'object',
properties: {
name: { type: 'string', description: 'Name of user' },
age: { type: 'number', description: 'Age of user' },
},
additionalProperties: false,
required: ['name'],
title: 'user',
},
result: {
type: 'object',
properties: {
name: { type: 'string', description: 'Name of user' },
age: { type: 'number', description: 'Age of user' },
},
additionalProperties: false,
required: ['name'],
},
},
additionalProperties: false,
$schema: 'http://json-schema.org/draft-07/schema#',
},
sayHi: {
type: 'object',
properties: {
params: {
type: 'object',
properties: {
name: { type: 'string', title: 'name' },
},
required: ['name'],
},
result: { type: 'string' },
},
additionalProperties: false,
$schema: 'http://json-schema.org/draft-07/schema#',
},
}
}
*/