read-excel-file 9.0.4 → 9.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -2
- package/README.md +14 -5
- package/commonjs/parseSheetData/parseSheetData.js +9 -5
- package/commonjs/parseSheetData/parseSheetData.js.map +1 -1
- package/commonjs/parseSheetData/parseSheetData.test.js.map +1 -1
- package/modules/parseSheetData/parseSheetData.js +9 -5
- package/modules/parseSheetData/parseSheetData.js.map +1 -1
- package/modules/parseSheetData/parseSheetData.test.js.map +1 -1
- package/package.json +1 -1
- package/types/parseSheetData/parseSheetDataError.d.ts +14 -12
|
@@ -18,14 +18,15 @@ export interface ParseSheetDataValueRequiredError<
|
|
|
18
18
|
> {
|
|
19
19
|
row: number;
|
|
20
20
|
column: ColumnTitle;
|
|
21
|
-
|
|
22
|
-
type?: ParseSheetDataValueType<CustomType>;
|
|
21
|
+
columnIndex: number;
|
|
23
22
|
error: 'required';
|
|
24
23
|
reason: undefined;
|
|
25
24
|
// When `error` is `"required"`, `value` could only be `null` or `undefined`.
|
|
26
25
|
// * `null` means "cell is empty"
|
|
27
26
|
// * `undefined` means "column is missing"
|
|
28
27
|
value: null | undefined;
|
|
28
|
+
// When `type` is not specified, it assumes `type: String`.
|
|
29
|
+
type?: ParseSheetDataValueType<CustomType>;
|
|
29
30
|
}
|
|
30
31
|
|
|
31
32
|
interface ParseSheetDataError_<
|
|
@@ -38,19 +39,20 @@ interface ParseSheetDataError_<
|
|
|
38
39
|
// The answer is that `type` could only be `undefined` in case of `parseSheetData()` errors
|
|
39
40
|
// that originate from `type: String` parser while other type parsers can't have `type` be `undefined`.
|
|
40
41
|
//
|
|
41
|
-
|
|
42
|
+
ValueType extends ParseSheetDataValueType<unknown> | undefined,
|
|
42
43
|
ErrorMessage extends string,
|
|
43
44
|
ErrorReason extends string | undefined
|
|
44
45
|
> {
|
|
45
46
|
row: number;
|
|
46
47
|
column: ColumnTitle;
|
|
47
|
-
|
|
48
|
+
columnIndex: number;
|
|
48
49
|
error: ErrorMessage;
|
|
49
50
|
reason: ErrorReason;
|
|
50
51
|
// When `error` is not `"required"`, `value` is known to not be `null` or `undefined`
|
|
51
52
|
// because when `value` is `null` or `undefined`, it won't be parsed at all,
|
|
52
53
|
// so there can't be any error thrown during parsing phase.
|
|
53
54
|
value: CellValue;
|
|
55
|
+
type: ValueType;
|
|
54
56
|
}
|
|
55
57
|
|
|
56
58
|
export type ParseSheetDataCustomTypeErrorMessage<
|
|
@@ -131,10 +133,10 @@ interface ParseSheetDataErrorStringNumberOutOfBounds<ColumnTitle extends string
|
|
|
131
133
|
|
|
132
134
|
interface ParseSheetDataErrorNotANumber<
|
|
133
135
|
ColumnTitle extends string = string,
|
|
134
|
-
|
|
136
|
+
ValueType extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
135
137
|
> extends ParseSheetDataError_<
|
|
136
138
|
ColumnTitle,
|
|
137
|
-
|
|
139
|
+
ValueType,
|
|
138
140
|
'not_a_number',
|
|
139
141
|
undefined
|
|
140
142
|
> {
|
|
@@ -143,10 +145,10 @@ interface ParseSheetDataErrorNotANumber<
|
|
|
143
145
|
|
|
144
146
|
interface ParseSheetDataErrorNotANumberString<
|
|
145
147
|
ColumnTitle extends string = string,
|
|
146
|
-
|
|
148
|
+
ValueType extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
147
149
|
> extends ParseSheetDataError_<
|
|
148
150
|
ColumnTitle,
|
|
149
|
-
|
|
151
|
+
ValueType,
|
|
150
152
|
'not_a_number',
|
|
151
153
|
undefined
|
|
152
154
|
> {
|
|
@@ -155,10 +157,10 @@ interface ParseSheetDataErrorNotANumberString<
|
|
|
155
157
|
|
|
156
158
|
interface ParseSheetDataErrorNumberInvalid<
|
|
157
159
|
ColumnTitle extends string = string,
|
|
158
|
-
|
|
160
|
+
ValueType extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
159
161
|
> extends ParseSheetDataError_<
|
|
160
162
|
ColumnTitle,
|
|
161
|
-
|
|
163
|
+
ValueType,
|
|
162
164
|
'invalid_number',
|
|
163
165
|
undefined
|
|
164
166
|
> {
|
|
@@ -167,10 +169,10 @@ interface ParseSheetDataErrorNumberInvalid<
|
|
|
167
169
|
|
|
168
170
|
interface ParseSheetDataErrorNumberOutOfBounds<
|
|
169
171
|
ColumnTitle extends string = string,
|
|
170
|
-
|
|
172
|
+
ValueType extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
171
173
|
> extends ParseSheetDataError_<
|
|
172
174
|
ColumnTitle,
|
|
173
|
-
|
|
175
|
+
ValueType,
|
|
174
176
|
'out_of_bounds',
|
|
175
177
|
undefined
|
|
176
178
|
> {
|