VCF / vCard

Install via npm

$ npm install --save vcf

Index

Usage
- Parsing
Formats
- jCard
- vCard
API Reference
Benchmarks

Usage

var vCard = require( 'vcf' )

Parsing a Single vCard

var card = new vCard().parse( string )

vCard {
  version: '4.0',
  data: {
    version: [String: '4.0'],
    n: [String: 'Gump;Forrest;;;'],
    fn: [String: 'Forrest Gump'],
    org: [String: 'Bubba Gump Shrimp Co.'],
    title: [String: 'Shrimp Man'],
    photo: { [String: 'http://www.example.com/dir_photos/my_photo.gif'] mediatype: 'image/gif' },
    tel: [
      { [String: 'tel:+11115551212'] type: [ 'work', 'voice' ], value: 'uri' },
      { [String: 'tel:+14045551212'] type: [ 'home', 'voice' ], value: 'uri' }
    ],
    adr: [
      { [String: ';;100 Waters Edge;Baytown;LA;30314;United States of America']
        type: 'work',
        label: '"100 Waters Edge\\nBaytown, LA 30314\\nUnited States of America"' },
      { [String: ';;42 Plantation St.;Baytown;LA;30314;United States of America']
        type: 'home',
        label: '"42 Plantation St.\\nBaytown, LA 30314\\nUnited States ofAmerica"' }
    ],
    email: [String: 'forrestgump@example.com'],
    rev: [String: '20080424T195243Z']
  }
}

Parsing Multiple vCards

In order to deal with a string that contains multiple vCards, you will need to use a different function, which returns an array of cards:

var cards = vCard.parse( string )

Formats

Format: jCard

var card = vCard.fromJSON( data )

var jcard = card.toJSON()

[ "vcard",
  [
    [ "version", {}, "text", "4.0" ],
    [ "n", {}, "text", [ "Gump", "Forrest", "", "", "" ] ],
    [ "fn", {}, "text", "Forrest Gump" ],
    [ "org", {}, "text", "Bubba Gump Shrimp Co." ],
    [ "title", {}, "text", "Shrimp Man" ],
    [
      "photo", { "mediatype": "image/gif" },
      "text", "http://www.example.com/dir_photos/my_photo.gif"
    ],
    [ "tel", { "type": [ "work", "voice" ], "value": "uri" }, "uri", "tel:+11115551212" ],
    [ "tel", { "type": [ "home", "voice" ], "value": "uri" }, "uri", "tel:+14045551212" ],
    [
      "adr", { "type": "work", "label":"\"100 Waters Edge\\nBaytown, LA 30314\\nUnited States of America\"" },
      "text", [ "", "", "100 Waters Edge", "Baytown", "LA", "30314", "United States of America" ]
    ],
    [
      "adr", { "type": "home", "label": "\"42 Plantation St.\\nBaytown, LA 30314\\nUnited States ofAmerica\"" },
      "text", [ "", "", "42 Plantation St.", "Baytown", "LA", "30314", "United States of America" ]
    ],
    [ "email", {}, "text", "forrestgump@example.com" ],
    [ "rev", {}, "text", "20080424T195243Z" ]
  ]
]

Format: VCF

var vcf = card.toString()
var vcf = card.toString( '4.0' )

BEGIN:VCARD
VERSION:4.0
N:Gump;Forrest;;;
FN:Forrest Gump
ORG:Bubba Gump Shrimp Co.
TITLE:Shrimp Man
PHOTO;MEDIATYPE=image/gif:http://www.example.com/dir_photos/my_photo.gif
TEL;TYPE=work,voice;VALUE=uri:tel:+11115551212
TEL;TYPE=home,voice;VALUE=uri:tel:+14045551212
ADR;TYPE=work;LABEL="100 Waters Edge\nBaytown, LA 30314\nUnited States
  of America":;;100 Waters Edge;Baytown;LA;30314;United States of America
ADR;TYPE=home;LABEL="42 Plantation St.\nBaytown, LA 30314\nUnited
  States ofAmerica":;;42 Plantation St.;Baytown;LA;30314;United States of
 America
EMAIL:forrestgump@example.com
REV:20080424T195243Z
END:VCARD

API Reference

vCard

Kind: global class

vCard
- new vCard()
- instance
  - .version : String
  - .data : Object
  - .get(key) ⇒ Object | Array
  - .set(key, value, params)
  - .add(key, value, params)
  - .setProperty(prop)
  - .addProperty(prop)
  - .parse(value) ⇒ vCard
  - .toString(version, charset) ⇒ String
  - .toJCard(version) ⇒ Array
  - .toJSON() ⇒ Array
- static
  - .Property
    - new Property(field, value, params)
    - instance
      - .is(type) ⇒ Boolean
      - .isEmpty() ⇒ Boolean
      - .clone() ⇒ Property
      - .toString(version) ⇒ String
      - .valueOf() ⇒ String
      - .toJSON() ⇒ Array
    - static
      - .prototype : Object
      - .fromJSON(data) ⇒ Property
  - .mimeType : String
  - .extension : String
  - .versions : Array
  - .foldLine ⇒ String
  - .parseLines : function
  - .normalize(input) ⇒ String
  - .isSupported(version) ⇒ Boolean
  - .parse(value) ⇒ Array.<vCard>
  - .fromJSON(jcard) ⇒ vCard
  - .format(card, version) ⇒ String

new vCard()

vCard

vCard.version : `String`

Version number

Kind: instance property of vCard

vCard.data : `Object`

Card data

Kind: instance property of vCard