chek/dist/modules/function.d.ts

Minimal utility for checking types, working with arrays and objects.

/**
 * Noop
 */
export declare function noop(...args: any[]): void;
/**
 * Noop If
 * If function provided return no operation funciton.
 *
 * @param fn optional function.
 */
export declare function noopIf(fn?: any): any;
/**
 * Try Wrap
 * Generic helper for calling try catch on a method.
 * If a default method is provided it will return in on error
 * otherwise it will return null.
 *
 * @example
 * function func(val: any) { return isString(val); }
 * const result = tryWrap(func)();
 *
 * With params
 * tryWrap(JSON.stringify, { name: 'Adele', age: 30 }, null, 2)()
 *
 * With default
 * tryWrap(Number, '30')(35);
 * Where '35' is the default value on error.
 *
 * @param fn the parse method to be called in try/parse block.
 * @param args arguments to pass to above method.
 */
export declare function tryWrap(fn: (...args: any[]) => any, ...args: any[]): (def?: any) => any;
/**
 * Try Require
 * Tries to require a module returns null
 * if cannot require or empty object.
 *
 * @param name the name of module to try and require.
 * @param def optional default value on null.
 * @param isRoot used internally by tryRootRequire to require root modules.
 */
export declare function tryRequire(name: string, def?: any, isRoot?: boolean): any;
/**
 * Try Root Require
 * Tries to require module relative from root module.
 *
 * @param name the name of the module to try and require.
 * @param def the default value if null.
 */
export declare function tryRootRequire(name: string, def?: any): any;