$ npm install --save vcf
var vCard = require( 'vcf' )
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']
}
}
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 )
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" ]
]
]
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
Kind: global class
StringObjectObject | ArrayvCardStringArrayArrayBooleanBooleanPropertyStringStringArrayObjectPropertyStringStringArrayStringfunctionStringBooleanArray.<vCard>vCardStringvCard
StringVersion number
Kind: instance property of vCard
ObjectCard data
Kind: instance property of vCard
Object | ArrayGet a vCard property
Kind: instance method of vCard
| Param | Type |
|---|---|
| key | String |
Set a vCard property
Kind: instance method of vCard
| Param | Type |
|---|---|
| key | String |
| value | String |
| params | Object |
Add a vCard property
Kind: instance method of vCard
| Param | Type |
|---|---|
| key | String |
| value | String |
| params | Object |
Set a vCard property from an already constructed vCard.Property
Kind: instance method of vCard
| Param | Type |
|---|---|
| prop | Property |
Add a vCard property from an already constructed vCard.Property
Kind: instance method of vCard
| Param | Type |
|---|---|
| prop | Property |
vCardParse a vcf formatted vCard
Kind: instance method of vCard
| Param | Type |
|---|---|
| value | String |
StringFormat the vCard as vcf with given version
Kind: instance method of vCard
| Param | Type |
|---|---|
| version | String |
| charset | String |
ArrayFormat the card as jCard
Kind: instance method of vCard
Returns: Array - jCard
| Param | Type | Default |
|---|---|---|
| version | String | '4.0' |
ArrayFormat the card as jCard
Kind: instance method of vCard
Returns: Array - jCard
Kind: static class of vCard
BooleanBooleanPropertyStringStringArrayObjectPropertyvCard Property
| Param | Type |
|---|---|
| field | String |
| value | String |
| params | Object |
BooleanCheck whether the property is of a given type
Kind: instance method of Property
| Param | Type |
|---|---|
| type | String |
BooleanCheck whether the property is empty
Kind: instance method of Property
PropertyClone the property
Kind: instance method of Property
StringFormat the property as vcf with given version
Kind: instance method of Property
| Param | Type |
|---|---|
| version | String |
StringGet the property's value
Kind: instance method of Property
ArrayFormat the property as jCard data
Kind: instance method of Property
ObjectProperty prototype
Kind: static property of Property
PropertyConstructs a vCard.Property from jCard data
Kind: static method of Property
| Param | Type |
|---|---|
| data | Array |
StringvCard MIME type
Kind: static property of vCard
StringvCard file extension
Kind: static property of vCard
ArrayvCard versions
Kind: static property of vCard
StringFolds a long line according to the RFC 5322.
Kind: static property of vCard
See: http://tools.ietf.org/html/rfc5322#section-2.1.1
| Param | Type |
|---|---|
| input | String |
| maxLength | Number |
| hardWrap | Boolean |
functionParse an array of vcf formatted lines
Kind: static property of vCard
Internal: used by vCard#parse()
StringNormalizes input (cast to string, line folding, whitespace)
Kind: static method of vCard
| Param | Type |
|---|---|
| input | String |
BooleanCheck whether a given version is supported
Kind: static method of vCard
| Param | Type |
|---|---|
| version | String |
Array.<vCard>Parses a string or buffer into a vCard object
Kind: static method of vCard
| Param | Type |
|---|---|
| value | String | Buffer |
vCardConstructs a vCard from jCard data
Kind: static method of vCard
| Param | Type |
|---|---|
| jcard | Array |
StringFormat a card object according to the given version
Kind: static method of vCard
| Param | Type |
|---|---|
| card | vCard |
| version | String |
FAQs
Parse and construct vCards, jCards
The npm package vcf receives a total of 19,681 weekly downloads. As such, vcf popularity was classified as popular.
We found that vcf demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.