Ident Engine

A JavaScript library that retrieves and aggregates profiles from across the web

Documentation - Data Structures

The Identi Engine uses a number of different structures to store data. Listed below are are all the public structures for use in your code.

Navigating data structures

Always check for a properties existence
The parsers will often only return the structure needed to describe the values it has found. You should always check that a property or object exists in the structure before trying to retrieve it.

Multiple values
Where the microformat specification allows a property to have multiple values the property will always be an array even if only one value exists.

Property names
The microformats naming conventions for properties encourages the use of hyphens between words i.e. post-office-box. With JavaScript if the property name contains hyphens you need to address the property as an item of the property collection.

Addressing the property as below will not work

   hCard.adr[0].post-office-box

Addressing the property as an item of the property collection  will work as below

   hCard.adr[0]['post-office-box']

The rules for formatting microformats into JavaScript objects (JSON) are documented on the microformat wiki.