Convert Types

ConversionStatusType

Possible statuses for a conversion operation.

type ConversionStatusType = 'ENQUEUED' | 'PROCESSING' | 'SUCCESS' | 'ERROR';

ConversionResult

Extracted data from a successful conversion.

ConversionStatus

Status of a conversion operation, as returned by the API.

ConvertParams

Parameters for creating a conversion request. Provide exactly one of file, url, or base64 as the document source.

Type Guards

isConversionComplete(status)

Returns true if the conversion has reached a terminal state (SUCCESS or ERROR).

isConversionSuccess(status)

Returns true if the conversion completed successfully.

isConversionError(status)

Returns true if the conversion failed with an error.

import { isConversionSuccess, isConversionError } from 'docutray';

if (isConversionSuccess(status)) {
  console.log('Data:', status.data);
} else if (isConversionError(status)) {
  console.log('Error:', status.error);
}