forked from svrjs/svrjs
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# set-function-length <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
||
|
||
[![github actions][actions-image]][actions-url]
|
||
[![coverage][codecov-image]][codecov-url]
|
||
[![License][license-image]][license-url]
|
||
[![Downloads][downloads-image]][downloads-url]
|
||
|
||
[![npm badge][npm-badge-png]][package-url]
|
||
|
||
Set a function’s length.
|
||
|
||
Arguments:
|
||
- `fn`: the function
|
||
- `length`: the new length. Must be an integer between 0 and 2**32.
|
||
- `loose`: Optional. If true, and the length fails to be set, do not throw. Default false.
|
||
|
||
Returns `fn`.
|
||
|
||
## Usage
|
||
|
||
```javascript
|
||
var setFunctionLength = require('set-function-length');
|
||
var assert = require('assert');
|
||
|
||
function zero() {}
|
||
function one(_) {}
|
||
function two(_, __) {}
|
||
|
||
assert.equal(zero.length, 0);
|
||
assert.equal(one.length, 1);
|
||
assert.equal(two.length, 2);
|
||
|
||
assert.equal(setFunctionLength(zero, 10), zero);
|
||
assert.equal(setFunctionLength(one, 11), one);
|
||
assert.equal(setFunctionLength(two, 12), two);
|
||
|
||
assert.equal(zero.length, 10);
|
||
assert.equal(one.length, 11);
|
||
assert.equal(two.length, 12);
|
||
```
|
||
|
||
[package-url]: https://npmjs.org/package/set-function-length
|
||
[npm-version-svg]: https://versionbadg.es/ljharb/set-function-length.svg
|
||
[deps-svg]: https://david-dm.org/ljharb/set-function-length.svg
|
||
[deps-url]: https://david-dm.org/ljharb/set-function-length
|
||
[dev-deps-svg]: https://david-dm.org/ljharb/set-function-length/dev-status.svg
|
||
[dev-deps-url]: https://david-dm.org/ljharb/set-function-length#info=devDependencies
|
||
[npm-badge-png]: https://nodei.co/npm/set-function-length.png?downloads=true&stars=true
|
||
[license-image]: https://img.shields.io/npm/l/set-function-length.svg
|
||
[license-url]: LICENSE
|
||
[downloads-image]: https://img.shields.io/npm/dm/set-function-length.svg
|
||
[downloads-url]: https://npm-stat.com/charts.html?package=set-function-length
|
||
[codecov-image]: https://codecov.io/gh/ljharb/set-function-length/branch/main/graphs/badge.svg
|
||
[codecov-url]: https://app.codecov.io/gh/ljharb/set-function-length/
|
||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/set-function-length
|
||
[actions-url]: https://github.com/ljharb/set-function-length/actions
|