validateFunction

Description

It resolves if the parameter passed is a function type (lambda or closure).

Parameter List	Returns	Rejection Errors
`supposedFunction: Function` `tuple: Array (optional)`	`Promise<Function \|\| Array>`	`FunctionValidationError`
Related Functions	Function Signature
`filterResolutionParam`	`function supposedFunction(supposedString[, tuple]): Promise<Function \|\| Array>`

Examples

import { validateFunction } from "puddy-m/lib/validators";

validateFunction(console.log).then((validatedFunction) =>
  validatedFunction("I'm a function and I'm being invoked")
); // prints "I'm a function and I'm being invoked"

import { validateString, validateFunction } from "puddy-m/lib/validators";

validateFunction(console.log, [])
  .then((tuple) => validateString("string", tuple))
  .then(([logger, str]) => logger(str)); // prints 'string'

import { validateFunction } from "puddy-m/lib/validators";

const run = async () => {
  try {
    const validatedFunction = await validateFunction(() => {});

    console.log(validatedFunction); // prints [Function (anonymous)]
  } catch (e) {
    console.log(e);
  }
};

run();

import { validateFunction } from "puddy-m/lib/validators";

const run = async () => {
  try {
    const validatedFunction = await validateFunction("Not a function");

    console.log(emptyArray);
  } catch (e) {
    // Throws a FunctionValidationError
    console.log(e);
  }
};

run();