Document Type Types

DocumentType

A document type definition with its extraction schema.

ValidationErrorInfo

Details of a schema validation error.

ValidationWarningInfo

Details of a schema validation warning.

ValidationResult

Result of a document type schema validation.

DocumentTypesListParams

Parameters for listing document types.

Type Guards

isValidationValid(result)

Returns true if the validation passed with no errors.

hasValidationWarnings(result)

Returns true if the validation has warnings.

import { isValidationValid, hasValidationWarnings } from 'docutray';

if (isValidationValid(result)) {
  console.log('Schema is valid');
  if (hasValidationWarnings(result)) {
    console.log('Warnings:', result.warnings);
  }
}