index.js (1169B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Linked list. 23 * 24 * @module @stdlib/utils/linked-list 25 * 26 * @example 27 * var linkedList = require( '@stdlib/utils/linked-list' ); 28 * 29 * var list = linkedList(); 30 * 31 * // Add values to the list: 32 * list.push( 'foo' ).push( 'bar' ); 33 * 34 * // Remove the last value: 35 * var v = list.pop(); 36 * // returns 'bar' 37 * 38 * // Add a new value to the list: 39 * list.push( 'beep' ); 40 * 41 * // Remove the first list value: 42 * v = list.shift(); 43 * // returns 'foo' 44 */ 45 46 // MODULES // 47 48 var linkedList = require( './main.js' ); 49 50 51 // EXPORTS // 52 53 module.exports = linkedList;