Add namespace

kgryte · kgryte · commit 69df7158ce4a · 2017-06-13T22:01:10.000-07:00
diff --git a/lib/node_modules/@stdlib/types/README.md b/lib/node_modules/@stdlib/types/README.md
@@ -0,0 +1,50 @@
+# Types
+
+> Standard library types.
+
+
+<section class="usage">
+
+## Usage
+
+``` javascript
+var types = require( '@stdlib/types' );
+```
+
+#### types
+
+Standard library types.
+
+``` javascript
+var o = types;
+// returns {...}
+```
+
+</section>
+
+<!-- /.usage -->
+
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better examples -->
+
+``` javascript
+var getKeys = require( 'object-keys' ).shim();
+var ns = require( '@stdlib/types' );
+
+console.log( getKeys( ns ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->
diff --git a/lib/node_modules/@stdlib/types/examples/index.js b/lib/node_modules/@stdlib/types/examples/index.js
@@ -0,0 +1,6 @@
+'use strict';
+
+var getKeys = require( 'object-keys' ).shim();
+var ns = require( './../lib' );
+
+console.log( getKeys( ns ) );
diff --git a/lib/node_modules/@stdlib/types/lib/index.js b/lib/node_modules/@stdlib/types/lib/index.js
@@ -0,0 +1,33 @@
+'use strict';
+
+/*
+* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+
+
+// MAIN //
+
+/**
+* Top-level namespace.
+*
+* @namespace ns
+*/
+var ns = {};
+
+/**
+* @name Float64Array
+* @memberof ns
+* @readonly
+* @constructor
+* @see {@link module:@stdlib/types/Float64Array}
+*/
+setReadOnly( ns, 'Float64Array', require( '@stdlib/types/float64array' ) );
+
+
+// EXPORTS //
+
+module.exports = ns;
diff --git a/lib/node_modules/@stdlib/types/package.json b/lib/node_modules/@stdlib/types/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "@stdlib/types",
+  "version": "0.0.0",
+  "description": "Standard types.",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "scripts": {},
+  "main": "lib/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "types",
+    "data",
+    "structures"
+  ],
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "license": "Apache-2.0"
+}
diff --git a/lib/node_modules/@stdlib/types/test/test.js b/lib/node_modules/@stdlib/types/test/test.js
@@ -0,0 +1,22 @@
+'use strict';
+
+// MODULES //
+
+var tape = require( 'tape' );
+var getKeys = require( 'object-keys' ).shim();
+var ns = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is an object', function test( t ) {
+	t.ok( true, __filename );
+	t.equal( typeof ns, 'object', 'main export is an object' );
+	t.end();
+});
+
+tape( 'the exported object contains key-value pairs', function test( t ) {
+	var keys = getKeys( ns );
+	t.equal( keys.length > 0, true, 'has keys' );
+	t.end();
+});
