columns_duplicates_to_array: error and type

Author: wdavidw

CHANGELOG.md

@@ -10,6 +10,11 @@
 * promise: new API module
 * errors: finish normalisation of all errors
 
+## Trunk
+
+Minor improvements:
+* columns_duplicates_to_array: error and type
+
 ## Version 4.10.0
 
 New feature:

lib/es5/index.js

@@ -131,6 +131,13 @@ var Parser = /*#__PURE__*/function (_Transform) {
       options.columns = false;
     } else {
       throw new CsvError('CSV_INVALID_OPTION_COLUMNS', ['Invalid option columns:', 'expect an object, a function or true,', "got ".concat(JSON.stringify(options.columns))]);
+    } // Normalize option `columns_duplicates_to_array`
+
+
+    if (options.columns_duplicates_to_array === undefined || options.columns_duplicates_to_array === null || options.columns_duplicates_to_array === false) {
+      options.columns_duplicates_to_array = false;
+    } else if (options.columns_duplicates_to_array !== true) {
+      throw new CsvError('CSV_INVALID_OPTION_COLUMNS_DUPLICATES_TO_ARRAY', ['Invalid option columns_duplicates_to_array:', 'expect an boolean,', "got ".concat(JSON.stringify(options.columns_duplicates_to_array))]);
     } // Normalize option `comment`
 
 

lib/index.d.ts

@@ -77,6 +77,11 @@ declare namespace parse {
          * affect the result data set in the sense that records will be objects instead of arrays.
          */
         columns?: ColumnOption[] | boolean | ((record: any) => ColumnOption[]);
+        /**
+         * Convert values into an array of values when columns are activated and
+         * when multiple columns of the same name are found.
+         */
+        columns_duplicates_to_array?: boolean;
         /**
          * Treat all the characters after this one as a comment, default to '' (disabled).
          */

lib/index.js

@@ -79,6 +79,16 @@ class Parser extends Transform {
         `got ${JSON.stringify(options.columns)}`
       ])
     }
+    // Normalize option `columns_duplicates_to_array`
+    if(options.columns_duplicates_to_array === undefined || options.columns_duplicates_to_array === null || options.columns_duplicates_to_array === false){
+      options.columns_duplicates_to_array = false
+    }else if(options.columns_duplicates_to_array !== true){
+      throw new CsvError('CSV_INVALID_OPTION_COLUMNS_DUPLICATES_TO_ARRAY', [
+        'Invalid option columns_duplicates_to_array:',
+        'expect an boolean,',
+        `got ${JSON.stringify(options.columns_duplicates_to_array)}`
+      ])
+    }
     // Normalize option `comment`
     if(options.comment === undefined || options.comment === null || options.comment === false || options.comment === ''){
       options.comment = null

test/api.types.ts

@@ -29,13 +29,13 @@ describe('API Types', () => {
       const options: Options = parser.options
       const keys: string[] = Object.keys(options)
       keys.sort().should.eql([
-        'bom', 'cast', 'cast_date', 'columns', 'comment', 'delimiter',
-        'escape', 'from', 'from_line', 'info', 'ltrim', 'max_record_size',
-        'objname', 'on_record', 'quote', 'raw', 'record_delimiter',
-        'relax', 'relax_column_count', 'relax_column_count_less',
-        'relax_column_count_more', 'rtrim', 'skip_empty_lines',
-        'skip_lines_with_empty_values', 'skip_lines_with_error', 'to', 
-        'to_line', 'trim'
+        'bom', 'cast', 'cast_date', 'columns', 'columns_duplicates_to_array',
+        'comment', 'delimiter', 'escape', 'from', 'from_line', 'info', 'ltrim',
+        'max_record_size', 'objname', 'on_record', 'quote', 'raw',
+        'record_delimiter', 'relax', 'relax_column_count',
+        'relax_column_count_less', 'relax_column_count_more', 'rtrim',
+        'skip_empty_lines', 'skip_lines_with_empty_values',
+        'skip_lines_with_error', 'to',  'to_line', 'trim'
       ])
     })
 
@@ -151,6 +151,11 @@ describe('API Types', () => {
       }
     })
 
+    it('columns_duplicates_to_array', () => {
+      const options: Options = {}
+      options.columns_duplicates_to_array = true
+    })
+      
     it('comment', () => {
       const options: Options = {}
       options.comment = '\\'

test/option.columns_duplicates_to_array.coffee

@@ -3,7 +3,18 @@ parse = require '../lib'
 assert_error = require './api.assert_error'
 
 describe 'Option `columns_duplicates_to_array`', ->
+  
+  it 'validate', ->
+    (->
+      parse "", columns_duplicates_to_array: 'invalid'
+    ).should.throw
+      code: 'CSV_INVALID_OPTION_COLUMNS_DUPLICATES_TO_ARRAY'
+      message: [
+        'Invalid option columns_duplicates_to_array:',
+        'expect an boolean, got "invalid"'
+      ].join ' '
 
+    
   it 'when false', (next) ->
     parse """
     FIELD_1,FIELD_1