Looking for the parsers list and options? 👉 heads up to the Parsers reference
The object is composed of the following properties:
Name
Type
Required
Description
name
string
true
options
false
output
object
false
The output you want the parser to generate. In most cases, a file or a directory.
ParsersEngineDataBox
The parsers engine can take several input types called parsers engine data boxes. On start, the Parsers engine requires one of the data box types to be passed in as initial input.
typeVectorDataBox= { type:'vector'; format:'svg'|'pdf'; provider:'external'|'Specify'; extension: { vector?:string,// The text representation of the SVG file },}
Bitmap
typeBitmapDataBox= { type:'bitmap'; format:'png'|'wp2'|'avif'|'webp'|'jpg'|'jxl'; provider:'external'|'Specify'; extension: { bitmap?:Array<number>,// The array buffer representation of the bitmap file },}
The parsers produce different types of outputs based on your configuration and their proper capabilities. If not all the parsers accept an output configuration property, the ones which do always take a standardized type as input.
File
Use case: the parser is expected to produce exactly one file.