Merge pull request #1 from lofcz/1793-docs-public.members

document public members
sebastienros · Feb 27, 2024 · a002795 · a002795
2 parents 13983b5 + 0d8306a
commit a002795
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/Jint/Options.Extensions.cs b/Jint/Options.Extensions.cs
@@ -128,7 +128,8 @@ public static Options SetWrapObjectHandler(this Options options, Options.WrapObj
         }
 
         /// <summary>
-        /// 
+        /// Sets the handler used to build stack traces. This is useful if the code currently
+        /// running was transpiled (eg. TypeScript) and the source map of original code is available.
         /// </summary>
         public static Options SetBuildCallStackHandler(this Options options, Options.BuildCallStackDelegate buildCallStackHandler)
         {

diff --git a/Jint/Options.cs b/Jint/Options.cs
@@ -298,7 +298,9 @@ public class InteropOptions
             public WrapObjectDelegate WrapObjectHandler { get; set; } = static (engine, target, type) => new ObjectWrapper(engine, target, type);
 
             /// <summary>
-            ///
+            /// The handler used to build stack traces. Changing this enables mapping
+            /// stack traces to code different from the code being executed, eg. when
+            /// executing code traspiled from TypeScript.
             /// </summary>
             public BuildCallStackDelegate BuildCallStackHandler { get; set; } = static (string description, Location location, List<string>? arguments) => null;
 

diff --git a/Jint/Runtime/CallStack/JintCallStack.cs b/Jint/Runtime/CallStack/JintCallStack.cs
@@ -176,7 +176,7 @@ static void AppendLocation(
             // stack is one frame behind function-wise when we start to process it from expression level
             var index = _stack._size - 1 - excludeTop;
             var element = index >= 0 ? _stack[index] : (CallStackElement?) null;
-            var shortDescription = element?.ToString() ?? "";
+            var shortDescription = element?.ToString() ?? string.Empty;
 
             AppendLocation(ref builder, shortDescription, location, element, engine);
 
@@ -186,7 +186,7 @@ static void AppendLocation(
             while (index >= -1)
             {
                 element = index >= 0 ? _stack[index] : null;
-                shortDescription = element?.ToString() ?? "";
+                shortDescription = element?.ToString() ?? string.Empty;
 
                 AppendLocation(ref builder, shortDescription, location, element, engine);