Document and add getter

tmcw · tmcw · commit 5f6359c86f50 · 2015-05-27T09:46:22.000-04:00
diff --git a/README.md b/README.md
@@ -1,3 +1,39 @@
 # globals-docs
 
 Documentation URIs for JavaScript globals.
+
+## `docs`
+
+Docs: an object of documentation as a plain-old-javascript object.
+
+Has keys that correspond to environments:
+
+- builtin
+- nonstandard
+- browser
+- worker
+- node
+
+
+
+
+
+## `getDoc`
+
+Get a URL for a global object.
+
+### Parameters
+
+| name | type | description |
+| ---- | ---- | ----------- |
+| `name` | `string` | name of the global object |
+| `env` | `Array<string>` | environments that will be reached. By default tries all environments |
+
+
+### Examples
+
+```js
+getDoc('Array'); // yields MDC documentation for Array
+```
+
+Returns  the URL of the documentation resource, if found
diff --git a/index.js b/index.js
@@ -1 +1,32 @@
-module.exports = require('./globals-docs.json');
+var docs = require('./globals-docs.json');
+
+/**
+ * Docs: an object of documentation as a plain-old-javascript object.
+ *
+ * Has keys that correspond to environments:
+ *
+ * - builtin
+ * - nonstandard
+ * - browser
+ * - worker
+ * - node
+ */
+module.exports.docs = docs;
+
+/**
+ * Get a URL for a global object.
+ *
+ * @param {string} name name of the global object
+ * @param {Array<string>} env environments that will be reached. By default tries all environments
+ * @returns {string|undefined} the URL of the documentation resource, if found
+ * @example
+ * getDoc('Array'); // yields MDC documentation for Array
+ */
+module.exports.getDoc = function(name, env) {
+    if (!env) env = Object.keys(docs);
+
+    for (var i = 0; i < env.length; i++) {
+        var d = docs[env[i]][name];
+        if (d) return d;
+    }
+};
diff --git a/test.js b/test.js
@@ -2,6 +2,10 @@ var test = require('tape'),
   g = require('./');
 
 test('globals-docs', function(t) {
-  t.equal(typeof g, 'object');
+  t.equal(typeof g.docs, 'object');
+
+  t.equal(g.getDoc('Array'), 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array', 'Array');
+  t.equal(g.getDoc('Buffer'), 'https://nodejs.org/api/buffer.html', 'Buffer');
+
   t.end();
 });
