Skip to content
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

Jump to bottom

Correct the type definitions of Color#steps() #256

Merged
merged 2 commits into from
Dec 12, 2022
Merged

Correct the type definitions of Color#steps() #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47744a4
Correct the type definitions of Color#steps()
latin-1 Dec 2, 2022
58ec108
Update interpolation type test
latin-1 Dec 2, 2022
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
12 changes: 11 additions & 1 deletion types/src/interpolation.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import Color, { ColorTypes } from "./color";
import ColorSpace from "./space";
import { Methods } from "./deltaE/index";

export type Range = ((percentage: number) => number) & {
rangeArgs: { colors: [Color, Color]; options: Record<string, any> };
Expand All @@ -12,6 +13,7 @@ export interface RangeOptions {
outputSpace?: string | ColorSpace | undefined;
progression?: ((percentage: number) => number) | undefined;
premultiplied?: boolean | undefined;
hue?: "longer" | "shorter" | "increasing" | "decreasing" | "raw" | undefined;
}

export function range(range: Range, options?: RangeOptions): Range;
Expand Down Expand Up @@ -39,6 +41,14 @@ export function mix(
options?: MixOptions
): number;

export function steps(color1: ColorTypes | Range, color2: ColorTypes): Color[];
export interface StepsOptions extends RangeOptions {
maxDeltaE?: number | undefined;
deltaEMethod?: Methods | undefined;
steps?: number | undefined;
maxSteps?: number | undefined;
}

export function steps(color1: ColorTypes, color2: ColorTypes, options?: StepsOptions): Color[];
export function steps(range: Range, options?: StepsOptions): Color[];

export function register(color: typeof Color): void;
20 changes: 19 additions & 1 deletion types/test/interpolation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ range("red", "blue", {
outputSpace: "srgb_linear",
progression: (_: number) => 1,
premultiplied: false,
hue: "raw",
});

// @ts-expect-error
Expand All @@ -47,7 +48,24 @@ mix("red", "blue", {
});

steps("red", "blue"); // $ExpectType Color[]
steps(r, " blue"); // $ExpectType Color[]
// $ExpectType Color[]
steps("red", "blue", {
maxDeltaE: 1,
deltaEMethod: "2000",
steps: 10,
maxSteps: 100,
});
steps(r); // $ExpectType Color[]
// $ExpectType Color[]
steps(r, {
maxDeltaE: 1,
deltaEMethod: "2000",
steps: 10,
maxSteps: 100,
});

// @ts-expect-error
steps(r, "blue"); // $ExpectType Color[]

// @ts-expect-error
register();
Expand Down