nikkubio-dts
Utilities to generate sane and clean type definitions from JavaScript files.
About
This module provides pre and post processing helpers to a type definition pipeline.
You can use it via API or through a simple generator cli.
Usage
npx bio-dts --outDir dist/types -r libFeatures
Generates clean type definitions from ES5 code bases:
- ES5 prototypical classes + inheritance
- Optional parameters before required ones
- Function overloading (via
@overlordannotations, actually works!) - Converts JSDoc to TSDoc
- Only exposed documented parameters
- Validates, where needed declared parameters
Checkout the test fixtures for full coverage.
API
import {
preTransform,
postTransform,
generateTypes
} from 'bio-dts';
import * as typescript from 'typescript';
// transform JS so it keeps the shape,
// but is properly digestable by the typescript
// compiler
const transformedCode = preTransform(jsCode);
// post process typescript compiler type code
// removing internals, and fixing up the definitions
const transformedCode = postTransform(tsCode);
// execute the full pipeline, including invoking the
// typescript compiler
generateTypes(files, {
outDir: 'dist'
}, typescript);