Skip to content

vCard generator written in TypeScript for NodeJS that uses amazing ez-vcard library written in Java

Notifications You must be signed in to change notification settings

Maxim-Mazurok/ez-vcard

Repository files navigation

ez-vcard

npm

It is a vCard generator written in TypeScript for NodeJS that uses amazing ez-vcard library written in Java. It can read and write vCards in many different formats. The "ez" stands for "easy" because the goal is to create a library that's easy to use.

Getting started

  1. Install JDK
  2. Install make and g++ on Ubuntu: sudo apt install build-essential (to build node-java dependency)
  3. Install ez-vcard (this package)
    npm i ez-vcard

Usage in NodeJS

const ezVcard = require('ez-vcard').default;
(async () => {
  const vcard = await ezVcard({name: {first: 'Maxim'}});
  console.log(vcard);
})();

Usage in TypeScript

npm install @types/node typescript

src/vcard.ts

import ezVcard from 'ez-vcard';

(async () => {
  const vcard = await ezVcard({name: {first: 'Maxim'}});
  console.log(vcard);
})();

tsconfig.json

{
  "compilerOptions": {
    "esModuleInterop": true
  }
}

and run: npx ts-node src/vcard.ts or compile: npx tsc --outDir dist.

Note: the first run might take a while, because it downloads maven packages required for package to run. Subsequent runs will be much faster than the first one.

Features

About

vCard generator written in TypeScript for NodeJS that uses amazing ez-vcard library written in Java

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published