Skip to content
Jim Cowart edited this page May 10, 2014 · 6 revisions

The "top level" postal object effectively provides a namespace for postal's facilities.

  • The standard client (non-AMD) scenarios, the postal object is attached to the window.
  • The postal module (whether AMD, CommonJS or plain browser global) returns the postal object (and you can do with it what you need from there).
  • Older versions of postal had a CommonJS wrapper which returned a factory method - this is no longer the case.

CommonJS usage example:

// in node.js
var postal = require('postal'); 

For a breakdown of the members of the postal object, please go to the API Documentation home page and select the item under "The postal object" you wish to explore.

Clone this wiki locally