package
> [!NOTE] > This is a fork of https://github.com/cafreeman/remove-types. It's not marked as a fork because we want pull requests to target this repo and not "upstream".
npm install babel-remove-typesGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
babel-remove-types[!NOTE] This is a fork of https://github.com/cafreeman/remove-types. It's not marked as a fork because we want pull requests to target this repo and not "upstream".
A small library for transforming TypeScript code into JavaScript code in the least destructive way possible. This library exports a single function whose purpose is to preserve everything else about the code except for the actual TypeScript syntax itself. As a result, things like decorators and class fields should pass straight through without being transformed in any way.
import { removeTypes } from 'babel-remove-types';
const original = `
type AnimalType = 'cat' | 'dog';
// An interface for animals (this comment should be removed when transformed)
interface Animal {
type: AnimalType;
name: string;
age: number;
}
class Cat implements Animal {
type: AnimalType = 'cat';
name: string;
age: number;
constructor(name: string, age: number) {
// This is the name of the animal (this comment should stay)
this.name = name;
this.age = age;
}
}
`;
console.log(await removeTypes(original));
/*
class Cat {
type = 'cat';
constructor(name, age) {
// This is the name of the animal (this comment should stay)
this.name = name;
this.age = age;
}
}
*/removeTypes(code, prettierConfig = true): Promise<string>code: A string containing TypeScript code
prettierConfig:
trueremoveTypes will run Prettier with a very basic config on the transformed code before returning it. This allows us to clean up some of the "low-hanging" fruit leftover from the Babel transform, e.g. newlines at the beginning or end of the file.false will bypass the Prettier pass entirely.removeTypes will use it instead.returns Promise<string>: a string containing the transformed JavaScript output.
This library is heavily indebted to cyco130/detype and began as an extraction and refactor of one of its core functions.
Estimated unpacked size across 41 packages.
15.1 MB
Includes dependencies.
4 direct · 3 outdated