From cec9310d9203caa214fedb53b06e01f11ce8bbc9 Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Wed, 4 May 2022 10:31:07 +0800 Subject: [PATCH] docs: add file header --- tools/js-for-ts.js | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/tools/js-for-ts.js b/tools/js-for-ts.js index ba30fdae..53078497 100644 --- a/tools/js-for-ts.js +++ b/tools/js-for-ts.js @@ -1,3 +1,14 @@ +/** + * @fileoverview Tool to prepare JavaScript (+JSDoc) for TypeScript, inlining + * `@local`-marked `@typedef`'s, and building a faux class for `@export`-marked + * classes so the type can be exported out of a given file. + * @author Brett Zamir + */ + +//------------------------------------------------------------------------------ +// Requirements +//------------------------------------------------------------------------------ + import js2tsAssistant from "@es-joy/js2ts-assistant"; await js2tsAssistant({