@ironsoftware/ironpdf-engine-windows-x64 2024.4.2 → 2024.5.1

package/index.js

@@ -1,4 +1,4 @@
-let version = "2024.4.2"
+let version = "2024.5.2"
 let dir = __dirname
 
 

package/{ironpdf-engine-bin-2024.4.2 → ironpdf-engine-bin-2024.5.2}/IronPdf.xml

@@ -1646,6 +1646,122 @@
         <member name="P:IronPdf.ChromePdfRenderOptions.JpegQuality">
             <exclude/>
         </member>
+        <member name="T:IronPdf.Cleaner">
+            <summary>
+            The Cleaner class can be used to scan or sanitize (remove any potentially harmful content) PDF document.
+            </summary>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithSvg(System.String)">
+            <summary>
+            Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            <list type = "bullet" >
+            <item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Resulted as a serachable PDF</description></item>
+            <item><description>Layout might be inconsistency.</description></item>
+            </list>
+            </summary>
+            <param name="pdfFilePath">A PDF File path.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            <list type = "bullet" >
+            <item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Resulted as a serachable PDF</description></item>
+            <item><description>Layout might be inconsistency.</description></item>
+            </list>
+            </summary>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithBitmap(System.String)">
+            <summary>
+            Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Visually look the same</description></item>
+            <item><description>Resulted as a non-serachable PDF</description></item>
+            </list>
+            <param name="pdfFilePath">A PDF File path.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Visually look the same</description></item>
+            <item><description>Resulted as a non-serachable PDF</description></item>
+            </list>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeByRemoveSomeElements(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by remove some elements from the original PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Some function of original PDF might not working</description></item>
+            <item><description>Some content might be missing</description></item>
+            </list>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeByRecreatePdf(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by re-create PDF document with only text and image from the original PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(System.String,System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfFilePath">A PDF File path</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(System.Byte[],System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfBytes">a PDF bytes</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfDocument">a PdfDocument object</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="T:IronPdf.CleanerScanResult">
+            <summary>
+            Result from Cleaner scan functions. E.g. <see cref="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])"/>
+            </summary>
+        </member>
+        <member name="P:IronPdf.CleanerScanResult.IsDetected">
+            <summary>
+            Is any risk was found
+            </summary>
+        </member>
+        <member name="P:IronPdf.CleanerScanResult.Risks">
+            <summary>
+            A list of risk that has been detected.
+            </summary>
+        </member>
+        <member name="M:IronPdf.CleanerScanResult.ToString">
+            <summary>
+            A text summary of CleanerScanResult 
+            </summary>
+            <returns>A text summary of CleanerScanResult </returns>
+        </member>
         <member name="T:IronPdf.Deployment.ExternalSettings">
             <summary>
             This class will search for a class named "IronPdfExternalSettings" in all assembly and try to get the settings from that class

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@ironsoftware/ironpdf-engine-windows-x64",
-	"version": "2024.4.2",
-	"ironPdfEngineVersion": "2024.4.2",
+	"version": "2024.5.1",
+	"ironPdfEngineVersion": "2024.5.2",
 	"homepage": "https://ironpdf.com/nodejs",
 	"platform": "Windows",
 	"arch": "x64",