Class DocumentStraighteningResult

constructor

• new DocumentStraighteningResult(
      source?: DeepPartial<DocumentStraighteningResult>,
  ): DocumentStraighteningResult

  Parameters

  • Optionalsource: DeepPartial<DocumentStraighteningResult>

  Returns DocumentStraighteningResult

ReadonlystraightenedImage

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): Promise<
      {
          encodeImages?: () => Promise<void>;
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly straightenedImage?: ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null | undefined; serialize?: ((config?: ToJ...;
          straightenedImage?:
              | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<ImageInfo | null>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: (
                      imageSerializationMode: ImageSerializationMode,
                  ) => Promise<
                      {
                          buffer?: string;
                          clear?: () => ...;
                          encodeImage?: (options?: ...) => ...;
                          encodeInPlace?: () => ...;
                          hibernate?: () => ...;
                          info?: () => ...;
                          isRetained?: () => ...;
                          release?: () => ...;
                          retain?: () => ...;
                          saveImage?: (path: ..., options?: ...) => ...;
                          serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>) | undefined;
                          uniqueId?: string;
                      },
                  >;
                  uniqueId?: string;
              } & {}
              | null;
      },
  >

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns Promise<
      {
          encodeImages?: () => Promise<void>;
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly straightenedImage?: ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}) | null | undefined; serialize?: ((config?: ToJ...;
          straightenedImage?:
              | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<ImageInfo | null>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: (
                      imageSerializationMode: ImageSerializationMode,
                  ) => Promise<
                      {
                          buffer?: string;
                          clear?: () => ...;
                          encodeImage?: (options?: ...) => ...;
                          encodeInPlace?: () => ...;
                          hibernate?: () => ...;
                          info?: () => ...;
                          isRetained?: () => ...;
                          release?: () => ...;
                          retain?: () => ...;
                          saveImage?: (path: ..., options?: ...) => ...;
                          serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ... | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>) | undefined;
                          uniqueId?: string;
                      },
                  >;
                  uniqueId?: string;
              } & {}
              | null;
      },
  >