Skip to content

Commit cab7111

Browse files
authored
Change typings to always return null instead of undefined (#73)
1 parent f664009 commit cab7111

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

index.d.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ export type Model = 'rgb' | 'hsl' | 'hwb';
22

33
export type ColorString = {
44
get: {
5-
(color: string): {model: Model; value: number[]} | undefined;
6-
rgb: (color: string) => number[] | undefined;
7-
hsl: (color: string) => number[] | undefined;
8-
hwb: (color: string) => number[] | undefined;
5+
(color: string): {model: Model; value: number[]} | null;
6+
rgb: (color: string) => number[] | null;
7+
hsl: (color: string) => number[] | null;
8+
hwb: (color: string) => number[] | null;
99
};
1010
to: {
11-
hex: (r: number, g: number, b: number, a?: number) => string | undefined;
11+
hex: (r: number, g: number, b: number, a?: number) => string | null;
1212
rgb: {
13-
(r: number, g: number, b: number, a?: number): string | undefined;
14-
percent: (r: number, g: number, b: number, a?: number) => string | undefined;
13+
(r: number, g: number, b: number, a?: number): string | null;
14+
percent: (r: number, g: number, b: number, a?: number) => string | null;
1515
};
16-
keyword: (r: number, g: number, b: number, a?: number) => string | undefined;
17-
hsl: (h: number, s: number, l: number, a?: number) => string | undefined;
18-
hwb: (h: number, w: number, b: number, a?: number) => string | undefined;
16+
keyword: (r: number, g: number, b: number, a?: number) => string | null;
17+
hsl: (h: number, s: number, l: number, a?: number) => string | null;
18+
hwb: (h: number, w: number, b: number, a?: number) => string | null;
1919
};
2020
};
2121

index.test-d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import {expectType} from 'tsd';
22
import colorString, {type Model} from './index.js';
33

4-
type GetColorResult = {model: Model; value: number[]} | undefined;
5-
type GetSpecificTypeResult = number[] | undefined;
4+
type GetColorResult = {model: Model; value: number[]} | null;
5+
type GetSpecificTypeResult = number[] | null;
66

7-
type ToColorResult = string | undefined;
7+
type ToColorResult = string | null;
88

99
expectType<GetColorResult>(colorString.get('#FFF'));
1010
expectType<GetColorResult>(colorString.get('#FFFA'));

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
"xo": {
2727
"rules": {
2828
"no-cond-assign": 0,
29-
"operator-linebreak": 0
29+
"operator-linebreak": 0,
30+
"@typescript-eslint/ban-types": 0
3031
}
3132
},
3233
"dependencies": {

0 commit comments

Comments
 (0)