/
readCsvSync.js
38 lines (37 loc) · 1.55 KB
/
readCsvSync.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
import readDataSync from '../readers/readDataSync'
import parserCsv from '../parsers/csv'
/**
* Synchronously read a comma-separated value file. Returns an empty array if file is empty.
*
* @function readCsvSync
* @param {String} filePath Input file path
* @param {Function|Object} [map] Optional map function or an object with `map` key that is a function. Called once for each row with the signature `(row, i)` and must return the transformed row. See example below or d3-dsv documentation for details.
* @returns {Array} the contents of the file as JSON
*
* @example
* var data = io.readCsvSync('path/to/data.csv')
* console.log(data) // Json data
*
* // Transform values on load
* var data = io.readCsvSync('path/to/data.csv', function (row, i, columns) {
* console.log(columns) // [ 'name', 'occupation', 'height' ]
* row.height = +row.height // Convert this value to a number
* return row
* })
* console.log(data) // Json data with casted values
*
* // Pass in an object with a `map` key
* var data = io.readCsvSync('path/to/data.csv', {map: function (row, i, columns) {
* console.log(columns) // [ 'name', 'occupation', 'height' ]
* row.height = +row.height // Convert this value to a number
* return row
* }})
* console.log(data) // Json data with casted values
*/
export default function readCsvSync (filePath, opts_) {
var parserOptions
if (typeof opts_ !== 'undefined') {
parserOptions = typeof opts_ === 'function' ? {map: opts_} : opts_
}
return readDataSync(filePath, {parser: parserCsv, parserOptions: parserOptions})
}