@stdlib/dstructs-doubly-linked-list 0.1.0

package/lib/node.js

@@ -0,0 +1,77 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var defineProperty = require( '@stdlib/utils-define-property' );
+
+
+// MAIN //
+
+/**
+* List node constructor.
+*
+* @private
+* @constructor
+* @param {*} value - node value
+* @returns {Node} Node instance
+*
+* @example
+* var node = new Node( 'foo' );
+* // returns <Node>
+*/
+function Node( value ) { // eslint-disable-line stdlib/no-redeclare
+	// Why getters? Because some of the list APIs will return the list "node", not the value. In which case, the node API is no longer private and we have to guard against users mucking about (deleting, updating, etc) with property values (in particular, the `next` and `prev` properties).
+	defineProperty( this, 'next', {
+		'configurable': false,
+		'enumerable': true,
+		'get': function get() { // eslint-disable-line no-restricted-syntax
+			return this._next;
+		}
+	});
+	defineProperty( this, 'prev', {
+		'configurable': false,
+		'enumerable': true,
+		'get': function get() { // eslint-disable-line no-restricted-syntax
+			return this._prev;
+		}
+	});
+	this.value = value;
+
+	defineProperty( this, '_next', {
+		'configurable': false,
+		'enumerable': false,
+		'writable': true,
+		'value': null
+	});
+	defineProperty( this, '_prev', {
+		'configurable': false,
+		'enumerable': false,
+		'writable': true,
+		'value': null
+	});
+
+	return this;
+}
+
+
+// EXPORTS //
+
+module.exports = Node;

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@stdlib/dstructs-doubly-linked-list",
+  "version": "0.1.0",
+  "description": "Doubly linked list.",
+  "license": "Apache-2.0",
+  "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"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/dstructs-doubly-linked-list.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/string-format": "^0.2.2",
+    "@stdlib/symbol-iterator": "^0.2.2",
+    "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.2.3",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
+    "@stdlib/utils-define-property": "^0.2.4",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "data structures",
+    "data structure",
+    "data",
+    "structure",
+    "collection",
+    "doubly",
+    "linked",
+    "list",
+    "queue",
+    "sequence"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}