Class DocumentCleanupResult

constructor

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

  Parameters

  • Optionalsource: DeepPartial<DocumentCleanupResult>

  Returns DocumentCleanupResult

Readonlyimage

Readonlystatus

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): Promise<
      {
          encodeImages?: () => Promise<void>;
          image?: {
              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<
                  (
                      { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; }
                  ),
              >;
              uniqueId?: string;
          };
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly status?: DocumentCleanupStatus | undefined; readonly image?: { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } | undefined;...;
          status?: DocumentCleanupStatus;
      },
  >

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns Promise<
      {
          encodeImages?: () => Promise<void>;
          image?: {
              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<
                  (
                      { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; }
                  ),
              >;
              uniqueId?: string;
          };
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly status?: DocumentCleanupStatus | undefined; readonly image?: { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } | undefined;...;
          status?: DocumentCleanupStatus;
      },
  >