ImageReader
Defined in: packages/readers/src/image.ts:6
Reads the content of an image file into a Document object (which stores the image file as a Blob).
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ImageReader():
ImageReader
Returns
Section titled “Returns”ImageReader
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addMetaData()
Section titled “addMetaData()”
staticaddMetaData(filePath): (doc,index) =>void
Defined in: packages/core/src/schema/type.ts:94
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”(
doc,index):void
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”loadData()
Section titled “loadData()”loadData(
filePath):Promise<ImageDocument<Metadata>[]>
Defined in: packages/core/src/schema/type.ts:65
Parameters
Section titled “Parameters”filePath
Section titled “filePath”string
Returns
Section titled “Returns”Promise<ImageDocument<Metadata>[]>
Inherited from
Section titled “Inherited from”loadDataAsContent()
Section titled “loadDataAsContent()”loadDataAsContent(
fileContent):Promise<ImageDocument<Metadata>[]>
Defined in: packages/readers/src/image.ts:13
Public method for this reader. Required by BaseReader interface.
Parameters
Section titled “Parameters”fileContent
Section titled “fileContent”Uint8Array
The content of the file.
Returns
Section titled “Returns”Promise<ImageDocument<Metadata>[]>
Promise<Document[]> A Promise object, eventually yielding zero or one ImageDocument of the specified file.