57 lines
1.1 KiB
JavaScript
57 lines
1.1 KiB
JavaScript
|
/**
|
||
|
|
* @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';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a function which always returns the same value.
|
||
|
|
*
|
||
|
|
* @param {*} [value] - value to always return
|
||
|
|
* @returns {Function} constant function
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var fcn = wrap( 3.14 );
|
||
|
|
*
|
||
|
|
* var v = fcn();
|
||
|
|
* // returns 3.14
|
||
|
|
*
|
||
|
|
* v = fcn();
|
||
|
|
* // returns 3.14
|
||
|
|
*
|
||
|
|
* v = fcn();
|
||
|
|
* // returns 3.14
|
||
|
|
*/
|
||
|
|
function wrap( value ) {
|
||
|
|
return constantFunction;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constant function.
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
* @returns {*} constant value
|
||
|
|
*/
|
||
|
|
function constantFunction() {
|
||
|
|
return value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = wrap;
|