YA-CSV 项目技术文档

本文档旨在帮助用户安装、使用及深入了解YA-CSV项目，该项目的Node.js库适用于处理大型CSV流。

1. 安装指南

在开始使用YA-CSV前，请确保您的系统中已安装Node.js。本项目至少需要Node.js版本v0.2.3，且已测试通过v0.4.12、v0.6.11、v0.7.5和v0.10.24版本。

通过以下命令安装YA-CSV：

npm install ya-csv

2. 项目使用说明

YA-CSV是一个基于事件的CSV解析器和写入器，适用于处理大型CSV流。以下是几个使用示例：

基础使用

var csv = require('ya-csv');

var reader = csv.createCsvStreamReader(process.openStdin());
var writer = csv.createCsvStreamWriter(process.stdout);

reader.addListener('data', function(data) {
    writer.writeRecord(data);
});

reader.addListener('error', function(e) {
    console.error('Oops!');
});

读取CSV文件

var reader = csv.createCsvFileReader('data.csv', {
    'separator': ',',
    'quote': '"',
    'escape': '"',
    'comment': '',
});

reader.addListener('data', function(data) {
    console.log(data);
});

转换输出

var reader = csv.createCsvFileReader('data.csv', {
    'separator': ':',
    'quote': '"',
    'escape': '"',
    'comment': '#',
});
var writer = new csv.CsvWriter(process.stdout);

reader.addListener('data', function(data) {
    writer.writeRecord(data);
});

读取并处理上传

upload_form.onPart = function(part) {
    if (!part.filename) { upload_form.handlePart(part); return }

    var reader = csv.createCsvFileReader({'comment': '#'});
    reader.addListener('data', function(data) {
        saveRecord(data);
    });

    part.on('data', function(buffer) {
        reader.parse(buffer);
    });
    part.on('end', function() {
        reader.end()
    })
}

3. 项目API使用文档

以下是YA-CSV项目的主要API接口：

CsvReader

选项	描述	默认值
separator	字段分隔符	,
quote	引号字符	"
escape	转义字符	"
comment	注释字符	无
columnNames	列名数组	无
columnsFromHeader	是否将首行视为列名	false
nestedQuotes	是否处理字段内的未转义引号	false
flags	传递给createRead/WriteStream的标志	无

CsvWriter

选项	描述	默认值
separator	字段分隔符	,
quote	引号字符	"
escape	转义字符	"
escapeFormulas	是否转义公式	false

4. 项目安装方式

项目安装方式已在“安装指南”部分详细描述。请使用以下命令：

npm install ya-csv