@mikezimm/npmfunctions
Version:
Functions used in my SPFx webparts
35 lines (34 loc) • 1.61 kB
TypeScript
/**
* @param exportStructure returns an object with selected this.properties to export via the help panel
* Should only be property keys that you want to import
* exportStructure = {
* key1: [ prop1, prop2, prop3 ] }
* }
* @param thisProperties - this is the webpart properties
* @returns
*/
export declare const exportNotAvailMess = "Export Unavailable";
export declare type IAny = any;
export interface IMinExportObject extends IAny {
[key: string]: string | string[] | any;
wpInstanceID: string;
currentWeb: string;
}
/**
*
* @param exportStructure - object with keys as groups of properties to export, will cycle through each group which has it's own property keys in string array
* @param thisProperties - webpart props
* @param ignoreProps - array of property keys to explicitly not export
* @param skipNullUndefined - false by default, will show null and undefined values in export
* @returns
*/
export declare function createExportObject(exportStructure: IMinExportObject, thisProperties: any, ignoreProps: string[], skipNullUndefined?: boolean): any;
/**
*
* @param updateOnThese - array of property keys to fetch from webpart props and save to exportProps object
* @param thisProperties - webpart props
* @param ignoreProps - array of property keys to explicitly not export
* @param skipNullUndefined - false by default, will show null and undefined values in export
* @returns
*/
export declare function createExportGroup(updateOnThese: string[], thisProperties: any, ignoreProps: string[], skipNullUndefined?: boolean): any;