Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 1.68 KB

README.md

File metadata and controls

60 lines (44 loc) · 1.68 KB

getHostMeta - Fetch and parse .well-known/host-meta

Version Downloads Build Status Dependency Status

Browser Support

What is this?

A browser module for looking up metadata about a host, using the /.well-known/host-meta[.json] files, which is useful for discovering associated services for a host, such as an OpenID endpoint or where to connect for an XMPP BOSH/WebSocket session.

Installing

$ npm install hostmeta

Building bundled/minified version (for AMD, etc)

$ make build

The bundled and minified files will be in the generated build directory.

How to use it

var getHostMeta = require('hostmeta');

getHostMeta('example.com', function (err, data) {
    if (err) {
        console.log("Couldn't retrieve host-meta data");
    }
    console.log(data);
    // Where data might look like:
    // {
    //   "links": [
    //     {
    //       "rel": "urn:xmpp:alt-connections:websocket",
    //       "href': "wss://example.com:5281/xmpp-websocket"
    //     },
    //     {
    //       "rel": "author",
    //       "href': "http://example.com/joe"
    //     }
    //   ]
    // }
});

License

MIT

Created By

If you like this, follow: @lancestout on twitter.