Detalhes do pacote

@stdlib/utils-constant-function

stdlib-js344kApache-2.00.2.2

Constant function.

stdlib, stdutils, stdutil, utilities

readme (leia-me)

<summary> About stdlib... </summary>

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Constant Function

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

Constant function.

A [constant function][constant-function] is a function whose output value is the same for every input value.
## Installation bash npm install @stdlib/utils-constant-function
## Usage javascript var constantFunction = require( '@stdlib/utils-constant-function' ); #### constantFunction( x ) Returns a [constant function][constant-function] which always returns x. javascript var fcn = constantFunction( 'beep' ); // returns <Function> var v = fcn(); // returns 'beep' v = fcn(); // returns 'beep'
## Notes - When provided an object reference, the returned function always returns the same reference. javascript var obj = {}; var fcn = constantFunction( obj ); var bool = ( fcn() === obj ); // returns true
## Examples javascript var constantFunction = require( '@stdlib/utils-constant-function' ); var bool; var fcn; var arr; var v; var i; fcn = constantFunction( 3.14 ); for ( i = 0; i < 10; i++ ) { v = fcn(); // returns 3.14 } arr = [ 1, 2, 3 ]; fcn = constantFunction( arr ); for ( i = 0; i < 10; i++ ) { v = fcn(); bool = ( v === arr ); // returns true }
* ## See Also - [@stdlib/utils-argument-function][@stdlib/utils/argument-function]: argument function. - [@stdlib/utils-identity-function][@stdlib/utils/identity-function]: identity function.
* ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-constant-function.svg [npm-url]: https://npmjs.org/package/@stdlib/utils-constant-function [test-image]: https://github.com/stdlib-js/utils-constant-function/actions/workflows/test.yml/badge.svg?branch=v0.2.2 [test-url]: https://github.com/stdlib-js/utils-constant-function/actions/workflows/test.yml?query=branch:v0.2.2 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-constant-function/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/utils-constant-function?branch=main [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/utils-constant-function/tree/deno [deno-readme]: https://github.com/stdlib-js/utils-constant-function/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/utils-constant-function/tree/umd [umd-readme]: https://github.com/stdlib-js/utils-constant-function/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/utils-constant-function/tree/esm [esm-readme]: https://github.com/stdlib-js/utils-constant-function/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/utils-constant-function/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-constant-function/main/LICENSE [constant-function]: https://en.wikipedia.org/wiki/Constant_function [@stdlib/utils/argument-function]: https://www.npmjs.com/package/@stdlib/utils-argument-function [@stdlib/utils/identity-function]: https://www.npmjs.com/package/@stdlib/utils-identity-function