@mikezimm/fps-core-v7
Version:
Library of reusable core interfaces, types and constants migrated from fps-library-v2
17 lines • 1.14 kB
TypeScript
export type IReturnErrorType = 'Actual' | 'FullError' | 'ShortError' | 'EmptyString';
/**
* checkDeepProperty - Originally built for Pivot Tiles banner component
* Checks for sub-sub-property of object by going one layer at a time to avoid undefined error
*
* 2023-08-10: As of now, passing in obj = null will cause this to crash :|
*
* @param obj - parent object you want to check
* @param keys - key array to check (parent.check.this keys are ['check','this'] )
* @param errReturnType - what to do when there is an error
* @param consoleLog - true is default due to being used before. Set to false to not show in console if it is not neccessary.
*/
export declare function checkDeepProperty(obj: any, keys: string[], errReturnType: IReturnErrorType, consoleLog?: boolean): any;
export declare function getDeepValuesStringArray(obj: any, deepProps: string[]): string[];
export declare function getDeepValuesArray(obj: any, deepProps: string[]): any[];
export declare function getDeepPropUsingDotNotation(obj: any, deepPropsStr: string, errReturnType: IReturnErrorType): any;
//# sourceMappingURL=deep.d.ts.map