tables.validatetable.md
June 23, 2023 ยท View on GitHub
Home > @datashaper/tables > validateTable
validateTable() function
Validates an entire table against a codebook's Field constraints.
Signature:
export declare function validateTable(table: ColumnTable, codebook: CodebookSchema, includeIndexes?: boolean): ValidationResult;
Parameters
| Parameter | Type | Description |
|---|---|---|
| table | ColumnTable | the table to validate |
| codebook | CodebookSchema | the codebook to use |
| includeIndexes | boolean | (Optional) indicate whether to include the indexes of the rows that failed validation for each field |
Returns:
ValidationResult