read-excel-file 5.3.1 → 5.3.4

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+5.3.4 / 11.06.2022
+==================
+
+* Added an optional `reason?: string` property of a with-schema parsing error.
+
+5.3.3 / 24.05.2022
+==================
+
+* Added `trim: false` option.
+
 5.3.0 / 18.05.2022
 ==================
 

package/README.md

@@ -157,7 +157,7 @@ const schema = {
 }
 
 readXlsxFile(file, { schema }).then(({ rows, errors }) => {
-  // `errors` list items have shape: `{ row, column, error, value }`.
+  // `errors` list items have shape: `{ row, column, error, reason?, value?, type? }`.
   errors.length === 0
 
   rows === [{
@@ -241,27 +241,34 @@ const { rows, errors } = convertToJson(data, schema)
 ```js
 import { parseExcelDate } from 'read-excel-file'
 
-function ParseExcelError({ children: error }) {
-  // Get a human-readable value.
-  let value = error.value
-  if (error.type === Date) {
-    value = parseExcelDate(value).toString()
-  }
-  // Render error summary.
+function ParseExcelError({ children }) {
+  const { type, value, error, reason, row, column } = children
+
+  // Error summary.
   return (
     <div>
-      <code>"{error.error}"</code>
+      <code>"{error}"</code>
+      {reason && ' '}
+      {reason && <code>("{reason}")</code>}
       {' for value '}
-      <code>"{value}"</code>
+      <code>{stringifyValue(value)}</code>
       {' in column '}
-      <code>"{error.column}"</code>
-      {error.type && ' of type '}
-      {error.type && <code>"{error.type.name}"</code>}
+      <code>"{column}"</code>
+      {type && type.name && ' of type '}
+      {type && type.name && <code>"{type.name}"</code>}
       {' in row '}
-      <code>"{error.row}"</code>
+      <code>{row}</code>
     </div>
   )
 }
+
+function stringifyValue(value) {
+  // Wrap strings in quotes.
+  if (typeof value === 'string') {
+    return '"' + value + '"'
+  }
+  return String(value)
+}
 ```
 </details>
 
@@ -338,6 +345,14 @@ When using `readXlsx()` with a `schema` parameter, all schema columns having typ
 readXlsxFile(file, { dateFormat: 'mm/dd/yyyy' })
 ```
 
+## Trim
+
+By default, it automatically trims all string values. To disable this feature, pass `trim: false` option.
+
+```js
+readXlsxFile(file, { trim: false })
+```
+
 ## Limitations
 
 ### Performance