urltomarkdown/node_modules/set-function-length
Lee Hanken d40eb12fa6 include generated API docs 2024-04-22 13:29:49 +01:00
..
.github include generated API docs 2024-04-22 13:29:49 +01:00
.eslintrc include generated API docs 2024-04-22 13:29:49 +01:00
.nycrc include generated API docs 2024-04-22 13:29:49 +01:00
CHANGELOG.md include generated API docs 2024-04-22 13:29:49 +01:00
LICENSE include generated API docs 2024-04-22 13:29:49 +01:00
README.md include generated API docs 2024-04-22 13:29:49 +01:00
env.d.ts include generated API docs 2024-04-22 13:29:49 +01:00
env.js include generated API docs 2024-04-22 13:29:49 +01:00
index.d.ts include generated API docs 2024-04-22 13:29:49 +01:00
index.js include generated API docs 2024-04-22 13:29:49 +01:00
package.json include generated API docs 2024-04-22 13:29:49 +01:00
tsconfig.json include generated API docs 2024-04-22 13:29:49 +01:00

README.md

set-function-length Version Badge

github actions coverage License Downloads

npm badge

Set a functions 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

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);