feat: expose columns with cast, info, on_record options

lib/browser/index.js

@@ -1452,7 +1452,9 @@ var Parser = /*#__PURE__*/function (_Transform) {
   }, {
     key: "__infoDataSet",
     value: function __infoDataSet() {
-      return _objectSpread({}, this.info);
+      return _objectSpread(_objectSpread({}, this.info), {}, {
+        columns: this.options.columns
+      });
     }
   }, {
     key: "__infoRecord",

lib/browser/sync.js

@@ -1452,7 +1452,9 @@ var Parser = /*#__PURE__*/function (_Transform) {
   }, {
     key: "__infoDataSet",
     value: function __infoDataSet() {
-      return _objectSpread({}, this.info);
+      return _objectSpread(_objectSpread({}, this.info), {}, {
+        columns: this.options.columns
+      });
     }
   }, {
     key: "__infoRecord",

lib/es5/index.js

@@ -1344,7 +1344,9 @@ var Parser = /*#__PURE__*/function (_Transform) {
   }, {
     key: "__infoDataSet",
     value: function __infoDataSet() {
-      return _objectSpread({}, this.info);
+      return _objectSpread(_objectSpread({}, this.info), {}, {
+        columns: this.options.columns
+      });
     }
   }, {
     key: "__infoRecord",

lib/index.js

@@ -1110,7 +1110,10 @@ class Parser extends Transform {
     }
   }
   __infoDataSet(){
-    return {...this.info}
+    return {
+      ...this.info,
+      columns: this.options.columns
+    }
   }
   __infoRecord(){
     const {columns} = this.options

test/api.info.coffee

@@ -9,6 +9,7 @@ describe 'API info', ->
     a,b,
     ''', (err, data, info) ->
       info.should.eql
+        columns: false
         comment_lines: 0
         empty_lines: 0
         invalid_field_length: 0
@@ -22,13 +23,32 @@ describe 'API info', ->
     a,b,c
     ''', (err, data, info) ->
       info.should.eql
+        columns: false
         comment_lines: 0
         empty_lines: 0
         invalid_field_length: 0
         lines: 2
         records: 2
       next err
 
+  it 'discovered columns are included', (next) ->
+    parse '''
+    a,b,c
+    1,2,3
+    ''', columns: true, (err, data, info) ->
+      info.should.eql
+        comment_lines: 0
+        columns: [
+          { name: 'a' }
+          { name: 'b' }
+          { name: 'c' }
+        ]
+        empty_lines: 0
+        invalid_field_length: 0
+        lines: 2
+        records: 1
+      next err
+
   it 'with multiline records', (next) ->
     parse '''
     a,b,c
@@ -37,6 +57,7 @@ describe 'API info', ->
     g,h,i
     ''', (err, data, info) ->
       info.should.eql
+        columns: false
         comment_lines: 0
         empty_lines: 0
         invalid_field_length: 0

test/option.cast.coffee

@@ -65,8 +65,9 @@ describe 'Option `cast`', ->
       , (err, records) ->
         records.should.eql [
           [[
-            'column', 'comment_lines', 'empty_lines', 'error', 'header',
-            'index', 'invalid_field_length', 'lines', 'quoting', 'records'
+            'column', 'columns', 'comment_lines', 'empty_lines', 'error',
+            'header', 'index', 'invalid_field_length', 'lines', 'quoting',
+            'records'
           ]]
         ] unless err
         next err
@@ -83,12 +84,12 @@ describe 'Option `cast`', ->
       , (err, records) ->
         records.should.eql [
           [ '2000-01-01T05:00:00.000Z', {
-            column: 1, comment_lines: 0, empty_lines: 0, error: undefined,
+            column: 1, columns: false, comment_lines: 0, empty_lines: 0, error: undefined,
             header: false, index: 1, invalid_field_length: 0, lines: 1,
             quoting: false, records: 0
           } ]
           [ '2050-11-27T05:00:00.000Z', {
-            column: 1, comment_lines: 0, empty_lines: 0, error: undefined,
+            column: 1, columns: false, comment_lines: 0, empty_lines: 0, error: undefined,
             header: false, index: 1, invalid_field_length: 0, lines: 2,
             quoting: false, records: 1
           } ]

test/option.info.coffee

@@ -29,7 +29,7 @@ describe 'Option `info`', ->
       ''', info: true, (err, records) ->
         {info} = records[0]
         Object.keys(info).sort().should.eql [
-          'comment_lines', 'empty_lines', 'error', 'header',
+          'columns', 'comment_lines', 'empty_lines', 'error', 'header',
           'index', 'invalid_field_length', 'lines', 'records'
         ]
         next err

test/option.on_record.coffee

@@ -10,71 +10,73 @@ describe 'Option `on_record`', ->
     ).should.throw
       message: 'Invalid option `on_record`: expect a function, got true'
       code: 'CSV_INVALID_OPTION_ON_RECORD'
-
-  it 'alter records', (next) ->
-    parse "a,b", on_record: (record) ->
-      [record[1], record[0]]
-    , (err, records) ->
-      records.should.eql [ ['b', 'a'] ] unless err
-      next err
-
-  it 'filter records', (next) ->
-    parse "a,b\nc,d\ne,f", on_record: (record, {lines}) ->
-      if lines is 2 then null else record
-    , (err, records) ->
-      records.should.eql [ ['a', 'b'], ['e', 'f'] ] unless err
-      next err
-
-  it 'errors with callback', (next) ->
-    parse "a,b\nc,d\ne,f",
-      on_record: (record, {lines}) ->
-        if lines is 2 then throw Error 'Error thrown on line 2' else record
-    , (err, records) ->
-      err.message.should.eql 'Error thrown on line 2'
-      next()
 
-  it 'errors with events', (next) ->
-    parser = parse "a,a,a\nc,d\ne,f"
-    parser.on 'error', (err) ->
-      err.message.should.eql 'Invalid Record Length: expect 3, got 2 on line 2'
-      next()
-    parser.on 'end', () ->
-      next Error 'Should not be called'
+  describe 'usage', ->
 
-  it 'errors not handled by skip_lines_with_error', (next) ->
-    parse "a,b\nc,d\ne,f",
-      on_record: (record, {lines}) ->
-        if lines is 2 then throw Error 'Error thrown on line 2' else record
-      skip_lines_with_error: true
-    , (err, records) ->
-      err.message.should.eql 'Error thrown on line 2'
-      next()
+    it 'alter records', (next) ->
+      parse "a,b", on_record: (record) ->
+        [record[1], record[0]]
+      , (err, records) ->
+        records.should.eql [ ['b', 'a'] ] unless err
+        next err
+
+    it 'filter records', (next) ->
+      parse "a,b\nc,d\ne,f", on_record: (record, {lines}) ->
+        if lines is 2 then null else record
+      , (err, records) ->
+        records.should.eql [ ['a', 'b'], ['e', 'f'] ] unless err
+        next err
+
+    it 'errors with callback', (next) ->
+      parse "a,b\nc,d\ne,f",
+        on_record: (record, {lines}) ->
+          if lines is 2 then throw Error 'Error thrown on line 2' else record
+      , (err, records) ->
+        err.message.should.eql 'Error thrown on line 2'
+        next()
+
+    it 'errors with events', (next) ->
+      parser = parse "a,a,a\nc,d\ne,f"
+      parser.on 'error', (err) ->
+        err.message.should.eql 'Invalid Record Length: expect 3, got 2 on line 2'
+        next()
+      parser.on 'end', () ->
+        next Error 'Should not be called'
+
+    it 'errors not handled by skip_lines_with_error', (next) ->
+      parse "a,b\nc,d\ne,f",
+        on_record: (record, {lines}) ->
+          if lines is 2 then throw Error 'Error thrown on line 2' else record
+        skip_lines_with_error: true
+      , (err, records) ->
+        err.message.should.eql 'Error thrown on line 2'
+        next()
 
-describe 'context', ->
-
-  it 'properties', (next) ->
-    parse "a,b",
-      on_record: (record, context) ->
-        Object.keys(context).sort()
-      skip_lines_with_error: true
-    , (err, records) ->
-      records.should.eql [[
-        'comment_lines', 'empty_lines', 'error', 'header',
-        'index', 'invalid_field_length', 'lines', 'records'
-      ]]
-      next()
-
-  it 'properties', (next) ->
-    parse "a,b\nc,d",
-      on_record: (record, context) ->
-        context
-      skip_lines_with_error: true
-    , (err, records) ->
-      records.should.eql [
-        comment_lines: 0, empty_lines: 0, error: undefined, header: false
-        index: 2, invalid_field_length: 0, lines: 1, records: 1
-      ,
-        comment_lines: 0, empty_lines: 0, error: undefined, header: false
-        index: 2, invalid_field_length: 0, lines: 2, records: 2
-      ]
-      next()
+  describe 'context', ->
+    
+    it 'properties', (next) ->
+      parse "a,b",
+        on_record: (record, context) ->
+          Object.keys(context).sort()
+        skip_lines_with_error: true
+      , (err, records) ->
+        records.should.eql [[
+          'columns', 'comment_lines', 'empty_lines', 'error', 'header',
+          'index', 'invalid_field_length', 'lines', 'records'
+        ]]
+        next()
+          
+    it 'values', (next) ->
+      parse "a,b\nc,d",
+        on_record: (record, context) ->
+          context
+        skip_lines_with_error: true
+      , (err, records) ->
+        records.should.eql [
+          columns: false, comment_lines: 0, empty_lines: 0, error: undefined, header: false
+          index: 2, invalid_field_length: 0, lines: 1, records: 1
+        ,
+          columns: false, comment_lines: 0, empty_lines: 0, error: undefined, header: false
+          index: 2, invalid_field_length: 0, lines: 2, records: 2
+        ]
+        next()