Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

Create a new function based on an existing function but with some parameters pre-defined.

 

Syntax

Code Block
themeEclipseRDark
languagejavascript
linenumberstrue
// create new function based on existing one with one or more pre-defined arguments
var fNewnewFn = fExistingexistingFn.uCurry(cArgscurry(args...);
 
// use the new function, optionally specifying additional arguments
fNew(args
var result = newFn(extraArgs...);

Parameters / Functions

fExistingcArgsargs
Parameter / FunctionTypeMandatoryDescriptionUtil.js versionAPI Version
existingFnFunction(tick)The original function1.0.5
args...One or more arguments(tick)

One or more arguments that will be passed in to

fExisting

existingFn when you access it via

fNew
0.5

newFn

If you don't specify any arguments, .curry() will just return existingFn as there's no point in creating a curried function.

1.0
extraArgs...Additional arguments(question)Optionally (based on requirements of fExisting) pass in remaining arguments when calling fNew newFn1.0.5

Return value

<fNew>
ValueTypeDescriptionUtil.js versionAPI Version
<newFn>FunctionA new function which will automatically set the cArgs arguments for fExisting and then append any additional arguments passed in to fNew.1.0.5
<fExisting><existingFn>FunctionIf you do not specify cArgs then the existing function will be returned.1.0.5
<result>VariantThe result of running newFn()1.0

Example

Code Block
themeEclipseRDark
languagejavascript
titleBasic example - pre-defining "not" and "a" params of a "booler" functionPredefining first param to a number...
linenumberstrue
function add(a, b) {
  return a + b;
}
 
var Add5To = add.curry(5); // parameter "a" is pre-defined with value 5
 
Add5To(10); // 15 (parameter "a" already set to 5, "b" set to 10)
A better example is shown in the Object.uAddProperty() example using a curried allianceExistsBetween() function.
Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox

Availability

This feature requires:

Util.js v0.5 and above.
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Function Manipulation

Topics:

Child pages (Children Display)
alltrue
depthall
pageFunction Manipulation
excerpttrue

Div
classbox

See

also

Also

Related articles:

  • Function.uCompose() – create a new function by merging two existing functions
  • Curry – I based my uCurry function on code samples from this blog (which includes more detailed information on how Curry works).

    pages: