nuncio

0.1.2 • Public • Published

nuncio

Function wrapper. Makes it easier to keep track of the context, parameters, change out the function, etc. Requires either Node 4 or Traceur.

static members

Nuncio.NUNCIO => Symbol(NUNCIO)

A symbol that can be used to see if a function has an associated nuncio and if so gain access to it.

Nuncio.create( function, context, parameters ) => nuncio

Create a new instance with a function, context object, and array of parameters.

Nuncio.nuncio( function, context, ...parameters ) => function

Create a new instance with a function, context object, and optionally parameters. Returns a function associated with the nuncio which adapts the nuncio to be used as a standard function.

instance members

nuncio.context

Can be a valid object or undefined.

nuncio.function

Can be a function, nuncio, or undefined.

nuncio.parameters

An array of parameters that will be used before any passed in when the function is called. Or can be undefined.

nuncio.setContext( context ) => nuncio

Sets the context and returns itself.

nuncio.setFunction( function ) => nuncio

Sets the function and returns itself.

nuncio.setParameters( [p1, p2, ..pN] ) => nuncio

Sets the parameters and returns itself.

nuncio.setParameterList( parameters ) => nuncio

Sets the parameters from an array and returns itself.

nuncio.apply( arguments ) => result

Calls the set function with the set context and parameters. Takes an array of additional arguments that will be used. Returns the result from the function.

nuncio.call( [arg1, arg2, ..argN] ) => result

Calls the set function with the set context and parameters. Optionally takes additional arguments that will be used. Returns the result from the function.

nuncio.bind() => function

Returns the set function with the set context and parameters bound to it. This function will not update if you change these settings after its bound.

nuncio.valueOf() => function

Returns an adapter function that when executed will use the settings current at that time.

function members

function[Nuncio.NUNCIO] => nuncio

Access the hidden nuncio backing a function.

Example

const nuncio = require( 'nuncio' ).nuncio; var funk = nuncio( console.log, null, 'Log:' ); funk( 1, 2, 3 );

Log: 1 2 3

License

ISC

Package Sidebar

Install

npm i nuncio

Weekly Downloads

1

Version

0.1.2

License

ISC

Last publish

Collaborators

  • kavlon