Skip to content

fix: better types #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2025
Merged

fix: better types #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ const { minify: minifyWorker } = require("./minify");
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {InferDefaultType<T>} minifyOptions
* @returns {Promise<MinimizedResult>}
* @returns {Promise<MinimizedResult> | MinimizedResult}
*/

/**
Expand Down
14 changes: 7 additions & 7 deletions src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ function throttleAll(limit, tasks) {
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function cssnanoMinify(
Expand Down Expand Up @@ -192,7 +192,7 @@ cssnanoMinify.supportsWorkerThreads = () => true;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function cssoMinify(input, sourceMap, minimizerOptions) {
Expand Down Expand Up @@ -221,7 +221,7 @@ cssoMinify.supportsWorkerThreads = () => true;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function cleanCssMinify(input, sourceMap, minimizerOptions) {
Expand Down Expand Up @@ -266,7 +266,7 @@ cleanCssMinify.supportsWorkerThreads = () => true;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function esbuildMinify(input, sourceMap, minimizerOptions) {
Expand Down Expand Up @@ -360,7 +360,7 @@ esbuildMinify.supportsWorkerThreads = () => false;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function parcelCssMinify(input, sourceMap, minimizerOptions) {
Expand Down Expand Up @@ -406,7 +406,7 @@ parcelCssMinify.supportsWorkerThreads = () => false;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function lightningCssMinify(input, sourceMap, minimizerOptions) {
Expand Down Expand Up @@ -452,7 +452,7 @@ lightningCssMinify.supportsWorkerThreads = () => false;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
async function swcMinify(input, sourceMap, minimizerOptions) {
Expand Down
2 changes: 1 addition & 1 deletion test/minify-option.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ describe('"minify" option', () => {
{ test: ".three{background: white;}" },
],
minify: [
async (data, inputMap, minimizerOptions) => {
(data, inputMap, minimizerOptions) => {
const [input] = Object.values(data);
return {
code: `${input}\n.one{color: red;}\n${minimizerOptions.test}\n`,
Expand Down
2 changes: 1 addition & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ type BasicMinimizerImplementation<T> = (
input: Input,
sourceMap: RawSourceMap | undefined,
minifyOptions: InferDefaultType<T>,
) => Promise<MinimizedResult>;
) => Promise<MinimizedResult> | MinimizedResult;
type MinimizeFunctionHelpers = {
supportsWorkerThreads?: (() => boolean | undefined) | undefined;
};
Expand Down
28 changes: 14 additions & 14 deletions types/utils.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,97 +26,97 @@ export function memoize<T>(fn: (() => any) | undefined): () => T;
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function cssnanoMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions?: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace cssnanoMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function cssoMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace cssoMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function cleanCssMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace cleanCssMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function esbuildMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace esbuildMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function parcelCssMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace parcelCssMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function lightningCssMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace lightningCssMinify {
function supportsWorkerThreads(): boolean;
}
/**
* @param {Input} input
* @param {RawSourceMap | undefined} sourceMap
* @param {CustomOptions} minimizerOptions
* @param {CustomOptions} [minimizerOptions]
* @return {Promise<MinimizedResult>}
*/
export function swcMinify(
input: Input,
sourceMap: RawSourceMap | undefined,
minimizerOptions: CustomOptions,
minimizerOptions?: import("./index.js").CustomOptions | undefined,
): Promise<MinimizedResult>;
export namespace swcMinify {
function supportsWorkerThreads(): boolean;
Expand Down