-
Notifications
You must be signed in to change notification settings - Fork 0
/
ClearScript.V8.xml
2124 lines (2124 loc) · 131 KB
/
ClearScript.V8.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>ClearScript.V8</name>
</assembly>
<members>
<member name="T:Microsoft.ClearScript.V8.V8CacheKind">
<summary>
Defines caching options for V8 script compilation.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheKind.None">
<summary>
Specifies that no cache data is to be generated or consumed during V8 script
compilation. This option results in the most efficient script compilation when no cache
data is available.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheKind.Parser">
<summary>
Selects parser caching. Parser cache data is smaller and less expensive to generate
than code cache data, but it is less effective at accelerating recompilation.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheKind.Code">
<summary>
Selects code caching. Code cache data is larger and more expensive to generate than
parser cache data, but it is more effective at accelerating recompilation.
</summary>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CacheResult">
<summary>
Defines cache data processing results for V8 script compilation.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheResult.Disabled">
<summary>
Indicates that cache data processing was disabled because the caller specified
<c><see cref="T:Microsoft.ClearScript.V8.V8CacheKind">V8CacheKind.None</see></c>.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheResult.Accepted">
<summary>
Indicates that the provided cache data was accepted and used to accelerate script
compilation.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheResult.Verified">
<summary>
Indicates that script compilation was bypassed because a suitable compiled script was
found in the V8 runtime's memory, but the provided cache data was verified to be
correct.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheResult.Updated">
<summary>
Indicates that the provided cache data was updated because it was empty, stale, or
invalid.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CacheResult.UpdateFailed">
<summary>
Indicates that the provided cache data was empty, stale, or invalid, but new cache data
could not be generated, and no additional information was provided by the V8 runtime.
</summary>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CpuProfile">
<summary>
Represents a V8 CPU profile.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Name">
<summary>
Gets the profile's name.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.StartTimestamp">
<summary>
Gets the profile's starting timestamp in microseconds.
</summary>
<remarks>
The timestamp specifies an offset relative to an unspecified moment in the past. All
timestamps within the profile are relative to the same moment.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.EndTimestamp">
<summary>
Gets the profile's ending timestamp in microseconds.
</summary>
<remarks>
The timestamp specifies an offset relative to an unspecified moment in the past. All
timestamps within the profile are relative to the same moment.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.RootNode">
<summary>
Gets the root node of the profile's call tree.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Samples">
<summary>
Gets the profile's sample collection.
</summary>
<remarks>
This property returns <c>null</c> if the profile contains no samples.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8CpuProfile.ToJson">
<summary>
Returns a JSON representation of the profile.
</summary>
<remarks>
See the
<see href="https://github.com/v8/v8/blob/4b9b23521e6fd42373ebbcb20ebe03bf445494f9/src/inspector/js_protocol-1.3.json">V8 Inspector JSON Protocol</see>
for schema details.
</remarks>
<returns>A JSON representation of the profile in V8 Inspector format.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8CpuProfile.WriteJson(System.IO.TextWriter)">
<summary>
Writes a JSON representation of the profile to the given text writer.
</summary>
<param name="writer">The text writer to which to write the profile.</param>
<remarks>
See the
<see href="https://github.com/v8/v8/blob/4b9b23521e6fd42373ebbcb20ebe03bf445494f9/src/inspector/js_protocol-1.3.json">V8 Inspector JSON Protocol</see>
for schema details.
</remarks>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CpuProfile.Node">
<summary>
Represents a node in a V8 CPU profile's call tree.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.NodeId">
<summary>
Gets the node's numeric identifier.
</summary>
<remarks>
This value is unique within the profile.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.ScriptId">
<summary>
Gets the numeric identifier of the document containing the node's script function.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.ScriptName">
<summary>
Gets the name or URL of the document containing the node's script function.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.FunctionName">
<summary>
Gets the name of the node's script function.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.LineNumber">
<summary>
Gets the 1-based line number of the start of the node's script function.
</summary>
<remarks>
A value of zero indicates that no line number is available.
</remarks>
<c><seealso cref="T:Microsoft.ClearScript.V8.V8CpuProfileFlags"/></c>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.ColumnNumber">
<summary>
Gets the 1-based column number of the start of the node's script function.
</summary>
<remarks>
A value of zero indicates that no column number is available.
</remarks>
<c><seealso cref="T:Microsoft.ClearScript.V8.V8CpuProfileFlags"/></c>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.HitCount">
<summary>
Gets the node's hit count.
</summary>
<remarks>
This value represents the number of times the CPU profiler observed the node's
script function at the top of the call stack.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.BailoutReason">
<summary>
Gets an optional string describing the reason why the node's script function was not optimized.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.HitLines">
<summary>
Gets the node's hit line collection.
</summary>
<remarks>
This property returns <c>null</c> if the node contains no hit lines.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Node.ChildNodes">
<summary>
Gets the node's child node collection.
</summary>
<remarks>
This property returns <c>null</c> if the node has no child nodes.
</remarks>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CpuProfile.Node.HitLine">
<summary>
Represents a script line observed by the V8 CPU profiler.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CpuProfile.Node.HitLine.LineNumber">
<summary>
Gets the 1-based line number.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CpuProfile.Node.HitLine.HitCount">
<summary>
Gets the hit count for the script line.
</summary>
<remarks>
This value represents the number of times the CPU profiler observed the current
script line at the top of the call stack.
</remarks>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CpuProfile.Sample">
<summary>
Represents a V8 CPU profile sample.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Sample.Node">
<summary>
Gets the sample's node within the profile's call tree.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8CpuProfile.Sample.Timestamp">
<summary>
Gets the sample's timestamp in microseconds.
</summary>
<remarks>
The timestamp specifies an offset relative to an unspecified moment in the past. All
timestamps within the profile are relative to the same moment.
</remarks>
</member>
<member name="T:Microsoft.ClearScript.V8.V8CpuProfileFlags">
<summary>
Defines options for creating a V8 CPU profile.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CpuProfileFlags.None">
<summary>
Specifies that no options are selected.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8CpuProfileFlags.EnableSampleCollection">
<summary>
Specifies that automatic sample collection is to be enabled.
</summary>
</member>
<member name="T:Microsoft.ClearScript.V8.V8GlobalFlags">
<summary>
Defines global V8 options.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8GlobalFlags.None">
<summary>
Specifies that no options are selected.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8GlobalFlags.EnableTopLevelAwait">
<summary>
Specifies that <see href="https://github.com/tc39/proposal-top-level-await">Top-Level Await</see> is to be enabled.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8GlobalFlags.DisableJITCompilation">
<summary>
Specifies that just-in-time compilation is to be disabled.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8GlobalFlags.DisableBackgroundWork">
<summary>
Specifies that background work is to be disabled. By default, V8 performs various tasks
in the background, accelerating garbage collection, just-in-time compilation, and other
activities. Use this option if you encounter issues related to V8's background work.
</summary>
</member>
<member name="T:Microsoft.ClearScript.V8.V8RuntimeViolationPolicy">
<summary>
Defines options for V8 runtime behavior in response to a violation.
</summary>
<c><seealso cref="P:Microsoft.ClearScript.V8.V8Runtime.MaxHeapSize"/></c>
<c><seealso cref="P:Microsoft.ClearScript.V8.V8ScriptEngine.MaxRuntimeHeapSize"/></c>
</member>
<member name="F:Microsoft.ClearScript.V8.V8RuntimeViolationPolicy.Interrupt">
<summary>
Specifies that the runtime is to interrupt script execution and throw a managed
exception. Additionally, further script execution is to be blocked until the host sets
the exceeded limit to a new value. This is the default behavior and the most effective
option for preventing process termination.
</summary>
</member>
<member name="F:Microsoft.ClearScript.V8.V8RuntimeViolationPolicy.Exception">
<summary>
Specifies that the runtime is to throw a script exception and disable monitoring until
the host sets the exceeded limit to a new value. This option is less effective at
preventing process termination than <c><see cref="F:Microsoft.ClearScript.V8.V8RuntimeViolationPolicy.Interrupt"/></c>, but it is more friendly to
asynchronous JavaScript, which relies on post-error processing for mechanisms such as
<see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">promise</see>
rejection.
</summary>
</member>
<member name="T:Microsoft.ClearScript.V8.V8Runtime">
<summary>
Represents an instance of the V8 runtime.
</summary>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor">
<summary>
Initializes a new V8 runtime instance.
</summary>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String)">
<summary>
Initializes a new V8 runtime instance with the specified name.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(Microsoft.ClearScript.V8.V8RuntimeConstraints)">
<summary>
Initializes a new V8 runtime instance with the specified resource constraints.
</summary>
<param name="constraints">Resource constraints for the instance.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String,Microsoft.ClearScript.V8.V8RuntimeConstraints)">
<summary>
Initializes a new V8 runtime instance with the specified name and resource constraints.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="constraints">Resource constraints for the instance.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(Microsoft.ClearScript.V8.V8RuntimeFlags)">
<summary>
Initializes a new V8 runtime instance with the specified options.
</summary>
<param name="flags">A value that selects options for the operation.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(Microsoft.ClearScript.V8.V8RuntimeFlags,System.Int32)">
<summary>
Initializes a new V8 runtime instance with the specified options and debug port.
</summary>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String,Microsoft.ClearScript.V8.V8RuntimeFlags)">
<summary>
Initializes a new V8 runtime instance with the specified name and options.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="flags">A value that selects options for the operation.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String,Microsoft.ClearScript.V8.V8RuntimeFlags,System.Int32)">
<summary>
Initializes a new V8 runtime instance with the specified name, options, and debug port.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(Microsoft.ClearScript.V8.V8RuntimeConstraints,Microsoft.ClearScript.V8.V8RuntimeFlags)">
<summary>
Initializes a new V8 runtime instance with the specified resource constraints and options.
</summary>
<param name="constraints">Resource constraints for the instance.</param>
<param name="flags">A value that selects options for the operation.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(Microsoft.ClearScript.V8.V8RuntimeConstraints,Microsoft.ClearScript.V8.V8RuntimeFlags,System.Int32)">
<summary>
Initializes a new V8 runtime instance with the specified resource constraints, options, and debug port.
</summary>
<param name="constraints">Resource constraints for the instance.</param>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String,Microsoft.ClearScript.V8.V8RuntimeConstraints,Microsoft.ClearScript.V8.V8RuntimeFlags)">
<summary>
Initializes a new V8 runtime instance with the specified name, resource constraints, and options.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="constraints">Resource constraints for the instance.</param>
<param name="flags">A value that selects options for the operation.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.#ctor(System.String,Microsoft.ClearScript.V8.V8RuntimeConstraints,Microsoft.ClearScript.V8.V8RuntimeFlags,System.Int32)">
<summary>
Initializes a new V8 runtime instance with the specified name, resource constraints, options, and debug port.
</summary>
<param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="constraints">Resource constraints for the instance.</param>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
</member>
<member name="E:Microsoft.ClearScript.V8.V8Runtime.DebuggerConnected">
<summary>
Occurs when a debugger connects to a V8 runtime.
</summary>
</member>
<member name="E:Microsoft.ClearScript.V8.V8Runtime.DebuggerDisconnected">
<summary>
Occurs when a debugger disconnects from a V8 runtime.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.Name">
<summary>
Gets the name associated with the V8 runtime instance.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.FormatCode">
<summary>
Enables or disables script code formatting.
</summary>
<remarks>
When this property is set to <c>true</c>, the V8 runtime may format script code before
executing or compiling it. This is intended to facilitate interactive debugging. The
formatting operation currently includes stripping leading and trailing blank lines and
removing global indentation.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.MaxHeapSize">
<summary>
Gets or sets a soft limit for the size of the V8 runtime's heap.
</summary>
<remarks>
<para>
This property is specified in bytes. When it is set to the default value, heap size
monitoring is disabled, and scripts with memory leaks or excessive memory usage
can cause unrecoverable errors and process termination.
</para>
<para>
A V8 runtime unconditionally terminates the process when it exceeds its resource
constraints (see <c><see cref="T:Microsoft.ClearScript.V8.V8RuntimeConstraints"/></c>). This property enables external
heap size monitoring that can prevent termination in some scenarios. To be effective,
it should be set to a value that is significantly lower than
<c><see cref="P:Microsoft.ClearScript.V8.V8RuntimeConstraints.MaxOldSpaceSize"/></c>. Note that enabling heap size
monitoring results in slower script execution.
</para>
<para>
Exceeding this limit causes the V8 runtime to behave in accordance with
<c><see cref="P:Microsoft.ClearScript.V8.V8Runtime.HeapSizeViolationPolicy"/></c>.
</para>
<para>
Note that
<c><see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer">ArrayBuffer</see></c>
memory is allocated outside the runtime's heap and is therefore not tracked by heap
size monitoring. See <c><see cref="P:Microsoft.ClearScript.V8.V8RuntimeConstraints.MaxArrayBufferAllocation"/></c> for
additional information.
</para>
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.HeapSizeSampleInterval">
<summary>
Gets or sets the minimum time interval between consecutive heap size samples.
</summary>
<remarks>
This property is effective only when heap size monitoring is enabled (see
<c><see cref="P:Microsoft.ClearScript.V8.V8Runtime.MaxHeapSize"/></c>).
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.MaxStackUsage">
<summary>
Gets or sets the maximum amount by which the stack is permitted to grow during script execution.
</summary>
<remarks>
<para>
This property is specified in bytes. When it is set to the default value, no stack
usage limit is enforced, and scripts with unchecked recursion or other excessive stack
usage can cause unrecoverable errors and process termination.
</para>
<para>
Note that the V8 runtime does not monitor stack usage while a host call is in progress.
Monitoring is resumed when control returns to the runtime.
</para>
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.DocumentSettings">
<summary>
Gets or sets the V8 runtime's document settings.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.EnableInterruptPropagation">
<summary>
Enables or disables interrupt propagation in the V8 runtime.
</summary>
<remarks>
By default, when nested script execution is interrupted via
<c><see cref="M:Microsoft.ClearScript.ScriptEngine.Interrupt"/></c>, an instance of
<c><see cref="T:Microsoft.ClearScript.ScriptInterruptedException"/></c>, if not handled by the host, is wrapped and
delivered to the parent script frame as a normal exception that JavaScript code can
catch. Setting this property to <c>true</c> causes the V8 runtime to remain in the
interrupted state until its outermost script frame has been processed.
</remarks>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.HeapSizeViolationPolicy">
<summary>
Gets or sets the V8 runtime's behavior in response to a violation of the maximum heap size.
</summary>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine">
<summary>
Creates a new V8 script engine instance.
</summary>
<returns>A new V8 script engine instance.</returns>
<remarks>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine(System.String)">
<summary>
Creates a new V8 script engine instance with the specified name.
</summary>
<param name="engineName">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<returns>A new V8 script engine instance.</returns>
<remarks>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine(Microsoft.ClearScript.V8.V8ScriptEngineFlags)">
<summary>
Creates a new V8 script engine instance with the specified options.
</summary>
<param name="flags">A value that selects options for the operation.</param>
<returns>A new V8 script engine instance.</returns>
<remarks>
<para>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</para>
<para>
V8 supports one script debugger per runtime. If script debugging has been enabled in
the current runtime, additional script engine instances cannot disable it or change its
TCP port, nor can they enable script debugging on a different port.
</para>
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine(Microsoft.ClearScript.V8.V8ScriptEngineFlags,System.Int32)">
<summary>
Creates a new V8 script engine instance with the specified options and debug port.
</summary>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
<returns>A new V8 script engine instance.</returns>
<remarks>
<para>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</para>
<para>
V8 supports one script debugger per runtime. If script debugging has been enabled in
the current runtime, additional script engine instances cannot disable it or change its
TCP port, nor can they enable script debugging on a different port.
</para>
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine(System.String,Microsoft.ClearScript.V8.V8ScriptEngineFlags)">
<summary>
Creates a new V8 script engine instance with the specified name and options.
</summary>
<param name="engineName">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="flags">A value that selects options for the operation.</param>
<returns>A new V8 script engine instance.</returns>
<remarks>
<para>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</para>
<para>
V8 supports one script debugger per runtime. If script debugging has been enabled in
the current runtime, additional script engine instances cannot disable it or change its
TCP port, nor can they enable script debugging on a different port.
</para>
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CreateScriptEngine(System.String,Microsoft.ClearScript.V8.V8ScriptEngineFlags,System.Int32)">
<summary>
Creates a new V8 script engine instance with the specified name, options, and debug port.
</summary>
<param name="engineName">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="flags">A value that selects options for the operation.</param>
<param name="debugPort">A TCP port on which to listen for a debugger connection.</param>
<returns>A new V8 script engine instance.</returns>
<remarks>
<para>
The new script engine instance shares the V8 runtime with other instances created by
this method and any of its overloads.
</para>
<para>
V8 supports one script debugger per runtime. If script debugging has been enabled in
the current runtime, additional script engine instances cannot disable it or change its
TCP port, nor can they enable script debugging on a different port.
</para>
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String)">
<summary>
Creates a compiled script.
</summary>
<param name="code">The script code to compile.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String)">
<summary>
Creates a compiled script with an associated document name.
</summary>
<param name="documentName">A document name for the compiled script. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="code">The script code to compile.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String)">
<summary>
Creates a compiled script with the specified document meta-information.
</summary>
<param name="documentInfo">A structure containing meta-information for the script document.</param>
<param name="code">The script code to compile.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Creates a compiled script, generating cache data for accelerated recompilation.
</summary>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Creates a compiled script with an associated document name, generating cache data for accelerated recompilation.
</summary>
<param name="documentName">A document name for the compiled script. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Creates a compiled script with the specified document meta-information, generating cache data for accelerated recompilation.
</summary>
<param name="documentInfo">A structure containing meta-information for the script document.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Creates a compiled script, consuming previously generated cache data.
</summary>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Creates a compiled script with an associated document name, consuming previously generated cache data.
</summary>
<param name="documentName">A document name for the compiled script. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Creates a compiled script with the specified document meta-information, consuming previously generated cache data.
</summary>
<param name="documentInfo">A structure containing meta-information for the script document.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
<c><seealso cref="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)"/></c>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Creates a compiled script, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(System.String,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Creates a compiled script with an associated document name, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="documentName">A document name for the compiled script. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Compile(Microsoft.ClearScript.DocumentInfo,System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Creates a compiled script with the specified document meta-information, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="documentInfo">A structure containing meta-information for the script document.</param>
<param name="code">The script code to compile.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String)">
<summary>
Loads and compiles a script document.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory)">
<summary>
Loads and compiles a document with the specified category.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.DocumentContextCallback)">
<summary>
Loads and compiles a document with the specified category and context callback.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="contextCallback">An optional context callback for the requested document.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Loads and compiles a script document, generating cache data for accelerated recompilation.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Loads and compiles a document with the specified category, generating cache data for accelerated recompilation.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.DocumentContextCallback,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@)">
<summary>
Loads and compiles a document with the specified category and context callback, generating cache data for accelerated recompilation.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="contextCallback">An optional context callback for the requested document.</param>
<param name="cacheKind">The kind of cache data to be generated.</param>
<param name="cacheBytes">Cache data for accelerated recompilation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
The generated cache data can be stored externally and is usable in other V8 runtimes
and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Loads and compiles a script document, consuming previously generated cache data.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Loads and compiles a document with the specified category, consuming previously generated cache data.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.DocumentContextCallback,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[],System.Boolean@)">
<summary>
Loads and compiles a document with the specified category and context callback, consuming previously generated cache data.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="contextCallback">An optional context callback for the requested document.</param>
<param name="cacheKind">The kind of cache data to be consumed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheAccepted"><c>True</c> if <paramref name="cacheBytes"/> was accepted and used to accelerate script compilation, <c>false</c> otherwise.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. Note that script compilation may be bypassed if a suitable compiled
script already exists in the V8 runtime's memory. In that case, the cache data is
ignored and <paramref name="cacheAccepted"/> is set to <c>false</c>.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Loads and compiles a script document, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Loads and compiles a document with the specified category, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CompileDocument(System.String,Microsoft.ClearScript.DocumentCategory,Microsoft.ClearScript.DocumentContextCallback,Microsoft.ClearScript.V8.V8CacheKind,System.Byte[]@,Microsoft.ClearScript.V8.V8CacheResult@)">
<summary>
Loads and compiles a document with the specified category and context callback, consuming previously generated cache data and updating it if necessary.
</summary>
<param name="specifier">A string specifying the document to be loaded and compiled.</param>
<param name="category">An optional category for the requested document.</param>
<param name="contextCallback">An optional context callback for the requested document.</param>
<param name="cacheKind">The kind of cache data to be processed.</param>
<param name="cacheBytes">Cache data for accelerated compilation.</param>
<param name="cacheResult">The cache data processing result for the operation.</param>
<returns>A compiled script that can be executed by multiple V8 script engine instances.</returns>
<remarks>
To be accepted, the cache data must have been generated for identical script code by
the same V8 build. If returned, the updated cache data can be stored externally and is
usable in other V8 script engines and application processes.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.GetHeapInfo">
<summary>
Returns memory usage information.
</summary>
<returns>A <c><see cref="T:Microsoft.ClearScript.V8.V8RuntimeHeapInfo"/></c> object containing memory usage information.</returns>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CollectGarbage(System.Boolean)">
<summary>
Performs garbage collection.
</summary>
<param name="exhaustive"><c>True</c> to perform exhaustive garbage collection, <c>false</c> to favor speed over completeness.</param>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.BeginCpuProfile(System.String)">
<summary>
Begins collecting a new CPU profile.
</summary>
<param name="name">A name for the profile.</param>
<returns><c>True</c> if the profile was created successfully, <c>false</c> otherwise.</returns>
<remarks>
A V8 runtime can collect multiple CPU profiles simultaneously.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.BeginCpuProfile(System.String,Microsoft.ClearScript.V8.V8CpuProfileFlags)">
<summary>
Begins collecting a new CPU profile with the specified options.
</summary>
<param name="name">A name for the profile.</param>
<param name="flags">Options for creating the profile.</param>
<returns><c>True</c> if the profile was created successfully, <c>false</c> otherwise.</returns>
<remarks>
A V8 runtime can collect multiple CPU profiles simultaneously.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.EndCpuProfile(System.String)">
<summary>
Completes and returns a CPU profile.
</summary>
<param name="name">The name of the profile.</param>
<returns>The profile if it was found and completed successfully, <c>null</c> otherwise.</returns>
<remarks>
An empty <paramref name="name"/> argument selects the most recently created CPU profile.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.CollectCpuProfileSample">
<summary>
Collects a sample in all CPU profiles active in the V8 runtime.
</summary>
</member>
<member name="P:Microsoft.ClearScript.V8.V8Runtime.CpuProfileSampleInterval">
<summary>
Gets or sets the time interval between automatic CPU profile samples, in microseconds.
</summary>
<remarks>
Assigning this property has no effect on CPU profiles already active in the V8 runtime.
The default value is 1000.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.WriteHeapSnapshot(System.IO.Stream)">
<summary>
Writes a heap snapshot to the given stream.
</summary>
<param name="stream">The stream to which to write the heap snapshot.</param>
<remarks>
This method generates a heap snapshot in JSON format with ASCII encoding.
</remarks>
</member>
<member name="M:Microsoft.ClearScript.V8.V8Runtime.Dispose">