Skip to content

Commit 67db3f9

Browse files
committed
ref #6 Updated README and bump up version to v1.1.0
1 parent c9a24be commit 67db3f9

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.0] - 2018-08-20
9+
### Added
10+
- Allow semicolon as a field delimiter as it is commonly used in CSV in some regions. Thanks to @HKskn.
11+
[PR #8](https://github.com/ryu1kn/csv-writer/pull/8), [#6](https://github.com/ryu1kn/csv-writer/pull/6)
12+
813
## [1.0.1] - 2018-08-09
914
### Fixed
1015
- Fixed the issue that coverage report badge on README shows question mark.

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# CSV Writer
66

77
Convert objects/arrays into a CSV string or write them into a file.
8+
It respects [RFC 4180](https://tools.ietf.org/html/rfc4180) for the output CSV format.
89

910
## Prerequisite
1011

@@ -133,6 +134,10 @@ console.log(csvStringifier.stringifyRecords(records));
133134
Array of objects (`id` and `title` properties) or strings (field IDs).
134135
A header line will be written to the file only if given as an array of objects.
135136

137+
* fieldDelimiter `<string>` (optional)
138+
139+
Default: `,`. Only either comma `,` or semicolon `;` is allowed.
140+
136141
* encoding `<string>` (optional)
137142

138143
Default: `utf8`.
@@ -162,6 +167,10 @@ console.log(csvStringifier.stringifyRecords(records));
162167

163168
Array of field titles
164169

170+
* fieldDelimiter `<string>` (optional)
171+
172+
Default: `,`. Only either comma `,` or semicolon `;` is allowed.
173+
165174
* encoding `<string>` (optional)
166175

167176
Default: `utf8`.
@@ -201,6 +210,10 @@ console.log(csvStringifier.stringifyRecords(records));
201210

202211
Array of objects (`id` and `title` properties) or strings (field IDs)
203212

213+
* fieldDelimiter `<string>` (optional)
214+
215+
Default: `,`. Only either comma `,` or semicolon `;` is allowed.
216+
204217
##### Returns:
205218

206219
* `<ObjectCsvStringifier>`
@@ -230,6 +243,10 @@ console.log(csvStringifier.stringifyRecords(records));
230243

231244
Array of field titles
232245

246+
* fieldDelimiter `<string>` (optional)
247+
248+
Default: `,`. Only either comma `,` or semicolon `;` is allowed.
249+
233250
##### Returns:
234251

235252
* `<ArrayCsvStringifier>`

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "csv-writer",
3-
"version": "1.0.1",
3+
"version": "1.1.0",
44
"description": "Convert objects/arrays into a CSV string or write them into a CSV file",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)