Class WorkerDocumentEnhancer

This class is used inside the JS Worker and interacts directly with the WASM.

Index

Constructors

Methods

create destroy isAvailable isStraighteningModeAvailable straighten

Constructors

constructor

new WorkerDocumentEnhancer(getWasmModule): WorkerDocumentEnhancer
Parameters
- getWasmModule: (() => any)
  - - (): any
    - Returns any
Returns WorkerDocumentEnhancer

Methods

create

create(): Promise<ObjectId<"DocumentEnhancer">>
Returns Promise<ObjectId<"DocumentEnhancer">>

destroy

destroy(instanceId): Promise<void>
Parameters
- instanceId: ObjectId<"DocumentEnhancer">
Returns Promise<void>

isAvailable

isAvailable(): Promise<boolean>
Returns Promise<boolean>

isStraighteningModeAvailable

isStraighteningModeAvailable(mode): Promise<boolean>
Parameters
- mode: DocumentStraighteningMode
Returns Promise<boolean>

straighten

straighten(instanceId, image, parameters, priorCornersNormalized): Promise<{
originalImage: Image;
result: DocumentStraighteningResult;
}>
Parameters
- instanceId: ObjectId<"DocumentEnhancer">
- image: Image
- parameters: DocumentStraighteningParameters
- priorCornersNormalized: Point[]
Returns Promise<{
originalImage: Image;
result: DocumentStraighteningResult;
}>

Generated using TypeDoc