flysh
Version:
DOM Document Object Artifact Collector
65 lines • 1.94 kB
TypeScript
/**
* 'PageRecords' class model
*
* The class is instanciated and filled by the 'Flysh' class during page(s) parsing. The data collection is structured
* as an array of 'Map'. In case of exception during process, the 'error' flag is set to true (i.e: timeout, crash,...).
*
* Example of the output data format sent back after page(s) parsing,
* [
* ['item_name' : 'some name', 'item_description' : 'some description',...],
* ['item_name' : 'some name', 'item_description' : 'some description',...],
* ...
* ]
*/
export declare class PageRecords {
/**
* Class properties
*/
private _error;
private _recordList;
private _uri;
/**
* Constructor
*
* @param uri Contains the full 'URI' address
* @param error Value being set in case of error (timeout, exception,...)
*/
constructor(uri: string, error: boolean);
/**
* Getter 'Error'
*
* @returns Returns a 'boolean' value setted to true in case of error
*/
get getError(): boolean;
/**
* Setter 'Error'
*
* @param error Contains the 'boolean' value to set in case of successful/unsuccessful process
*/
setError(error: boolean): void;
/**
* Getter 'URI'
*
* @returns Returns a 'string' that contains the URI value
*/
get URI(): string;
/**
* Getter 'RecordList'
*
* @returns Returns an array of 'Map' that contains the list of records
*/
get recordList(): Array<Map<String, String>>;
/**
* Returns the number of records from the current page
*
* @returns Returns the count of records from the record list
*/
get numberRecords(): number;
/**
* 'Stringify' the class instance
*
* @returns Returns a 'string' that contains all the class properties
*/
get toString(): string;
}
//# sourceMappingURL=PageRecords.d.ts.map