Helper utilities
These utilities can be imported and used within your own projects, as they are already used within kolay.
This should allow users to build their own specific set of outputs using the same underlying tools that kolay uses.
gitRef
Returns the short git SHA of the current commit. Useful for displaying the deployed version somewhere in your app.
In an ESM environment:
import { gitRef } from "kolay/build";
// in some config
version: gitRef();In a CJS environment (e.g. ember-cli-build.js):
const { gitRef } = require("kolay/build/legacy");
// in some config
version: gitRef();
gitRef
-
() =>string
packageTypes
packageTypes
-
(packageNamestring) =>Promise<>
- dirstring
- manifestany
- typesArray ofstring
-
virtualFile
virtualFile
-
(optionsVirtualFileOptionsArray ofVirtualFileOptions) =>Omit<UnpluginOptions>"name"
generateTypeDocJSON
generateTypeDocJSON
-
(optionsOptions) =>Promise<unknown>