Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
parse vCard files/data into JSON
JavaScript
branch: master

This branch is 26 commits behind jasperla:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
tests
.gitignore
COPYING
README.md
package.json
vcard.js

README.md

node-vcard

Introduction

node-vcard parses vCard data into nice JSON. It can read files from disk and then parse them with vCard.parseFile(), or the vCard data can be passed to it for direct parsing with vCard.parse().

This module only does basic validation of the files, so if you have NICKNAME field (added in version 3.0) in a 2.1 file and this causes issues elsewhere in the chain, it's your responsibility for now. Maybe in the future, it'll be ours...

Installation

npm install vcard

Usage

Please have a look at the stripped demo in bin/vcard-to-json.js. But basically you do:

var util = require('util');
var vCard = require('vcard');
var card = new vCard();
/* Use readFile() if the file is on disk. */
card.readFile("path/to/file.vcf", function(err, json) {
    console.log(util.inspect(json));
});
/* Use readData() otherwise. */
card.readData(String_with_vCard_data, function(err. json) {
    console.log(util.inspect(json));
}

Known bugs/limitations

  • Entries spanning multiple lines are currently treated as incorrect data.
  • Multiple entries (such as two TEL) will result in only the first one being recorded into the final JSON.

Author

Copyright (C) 2012 Jasper Lievisse Adriaanse jasper@humppa.nl

Distributed under the MIT/X11 license (see the file COPYING)

Something went wrong with that request. Please try again.