bio-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

1npx bio-dts --outDir dist/types -r lib

Features

Generates clean type definitions from ES5 code bases:

• ES5 prototypical classes + inheritance
• Optional parameters before required ones
• Function overloading (via @overlord annotations, actually works!)
• Converts JSDoc to TSDoc
• Only exposed documented parameters
• Validates, where needed declared parameters

Checkout the test fixtures for full coverage.

API

1import {
2  preTransform,
3  postTransform,
4  generateTypes
5} from 'bio-dts';
6
7import * as typescript from 'typescript';
8
9// transform JS so it keeps the shape,
10// but is properly digestable by the typescript
11// compiler
12const transformedCode = preTransform(jsCode);
13
14// post process typescript compiler type code
15// removing internals, and fixing up the definitions
16const transformedCode = postTransform(tsCode);
17
18// execute the full pipeline, including invoking the
19// typescript compiler
20generateTypes(files, {
21  outDir: 'dist'
22}, typescript);