ClearScript Library
ClearScript Library
ClearScript Library Reference
Microsoft.ClearScript.V8
V8Runtime Class
V8Runtime Constructor
V8Runtime Properties
V8Runtime Methods
V8Runtime Events

# V8Runtime Class

Represents an instance of the V8 runtime.
Inheritance Hierarchy
SystemObject
Microsoft.ClearScript.V8V8Runtime
Namespace: Microsoft.ClearScript.V8
Assembly: ClearScript.V8 (in ClearScript.V8.dll) Version: 7.5.0
Syntax
C#
VB
C++
F#
Copy

    public sealed class V8Runtime : IDisposable

    Public NotInheritable Class V8Runtime
    	Implements IDisposable

    public ref class V8Runtime sealed : IDisposable

    [<SealedAttribute>]
    type V8Runtime =
        class
            interface IDisposable
        end

The V8Runtime type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| V8Runtime | Initializes a new V8 runtime instance.
| V8Runtime(String) | Initializes a new V8 runtime instance with the specified name.
| V8Runtime(V8RuntimeConstraints) | Initializes a new V8 runtime instance with the specified resource constraints.
| V8Runtime(V8RuntimeFlags) | Initializes a new V8 runtime instance with the specified options.
| V8Runtime(String, V8RuntimeConstraints) | Initializes a new V8 runtime instance with the specified name and resource constraints.
| V8Runtime(String, V8RuntimeFlags) | Initializes a new V8 runtime instance with the specified name and options.
| V8Runtime(V8RuntimeConstraints, V8RuntimeFlags) | Initializes a new V8 runtime instance with the specified resource constraints and options.
| V8Runtime(V8RuntimeFlags, Int32) | Initializes a new V8 runtime instance with the specified options and debug port.
| V8Runtime(String, V8RuntimeConstraints, V8RuntimeFlags) | Initializes a new V8 runtime instance with the specified name, resource constraints, and options.
| V8Runtime(String, V8RuntimeFlags, Int32) | Initializes a new V8 runtime instance with the specified name, options, and debug port.
| V8Runtime(V8RuntimeConstraints, V8RuntimeFlags, Int32) | Initializes a new V8 runtime instance with the specified resource constraints, options, and debug port.
| V8Runtime(String, V8RuntimeConstraints, V8RuntimeFlags, Int32) | Initializes a new V8 runtime instance with the specified name, resource constraints, options, and debug port.

Top
Properties

| Name | Description
--- | --- | ---
| CpuProfileSampleInterval | Gets or sets the time interval between automatic CPU profile samples, in microseconds.
| DocumentSettings | Gets or sets the V8 runtime's document settings.
| EnableInterruptPropagation | Enables or disables interrupt propagation in the V8 runtime.
| FormatCode | Enables or disables script code formatting.
| HeapSizeSampleInterval | Gets or sets the minimum time interval between consecutive heap size samples.
| HeapSizeViolationPolicy | Gets or sets the V8 runtime's behavior in response to a violation of the maximum heap size.
| MaxHeapSize | Gets or sets a soft limit for the size of the V8 runtime's heap.
| MaxStackUsage | Gets or sets the maximum amount by which the stack is permitted to grow during script execution.
| Name | Gets the name associated with the V8 runtime instance.

Top
Methods

| Name | Description
--- | --- | ---
| BeginCpuProfile(String) | Begins collecting a new CPU profile.
| BeginCpuProfile(String, V8CpuProfileFlags) | Begins collecting a new CPU profile with the specified options.
| CollectCpuProfileSample | Collects a sample in all CPU profiles active in the V8 runtime.
| CollectGarbage | Performs garbage collection.
| Compile(String) | Creates a compiled script.
| Compile(DocumentInfo, String) | Creates a compiled script with the specified document meta-information.
| Compile(String, String) | Creates a compiled script with an associated document name.
| Compile(String, V8CacheKind, Byte) | Creates a compiled script, generating cache data for accelerated recompilation.
| Compile(DocumentInfo, String, V8CacheKind, Byte) | Creates a compiled script with the specified document meta-information, generating cache data for accelerated recompilation.
| Compile(String, V8CacheKind, Byte, Boolean) | Creates a compiled script, consuming previously generated cache data.
| Compile(String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script, consuming previously generated cache data and updating it if necessary.
| Compile(String, String, V8CacheKind, Byte) | Creates a compiled script with an associated document name, generating cache data for accelerated recompilation.
| Compile(DocumentInfo, String, V8CacheKind, Byte, Boolean) | Creates a compiled script with the specified document meta-information, consuming previously generated cache data.
| Compile(DocumentInfo, String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script with the specified document meta-information, consuming previously generated cache data and updating it if necessary.
| Compile(String, String, V8CacheKind, Byte, Boolean) | Creates a compiled script with an associated document name, consuming previously generated cache data.
| Compile(String, String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script with an associated document name, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String) | Loads and compiles a script document.
| CompileDocument(String, DocumentCategory) | Loads and compiles a document with the specified category.
| CompileDocument(String, DocumentCategory, DocumentContextCallback) | Loads and compiles a document with the specified category and context callback.
| CompileDocument(String, V8CacheKind, Byte) | Loads and compiles a script document, generating cache data for accelerated recompilation.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte) | Loads and compiles a document with the specified category, generating cache data for accelerated recompilation.
| CompileDocument(String, V8CacheKind, Byte, Boolean) | Loads and compiles a script document, consuming previously generated cache data.
| CompileDocument(String, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a script document, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte) | Loads and compiles a document with the specified category and context callback, generating cache data for accelerated recompilation.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte, Boolean) | Loads and compiles a document with the specified category, consuming previously generated cache data.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a document with the specified category, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte, Boolean) | Loads and compiles a document with the specified category and context callback, consuming previously generated cache data.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a document with the specified category and context callback, consuming previously generated cache data and updating it if necessary.
| CreateScriptEngine | Creates a new V8 script engine instance.
| CreateScriptEngine(String) | Creates a new V8 script engine instance with the specified name.
| CreateScriptEngine(V8ScriptEngineFlags) | Creates a new V8 script engine instance with the specified options.
| CreateScriptEngine(String, V8ScriptEngineFlags) | Creates a new V8 script engine instance with the specified name and options.
| CreateScriptEngine(V8ScriptEngineFlags, Int32) | Creates a new V8 script engine instance with the specified options and debug port.
| CreateScriptEngine(String, V8ScriptEngineFlags, Int32) | Creates a new V8 script engine instance with the specified name, options, and debug port.
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
| EndCpuProfile | Completes and returns a CPU profile.
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object)
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
| GetHashCode | Serves as the default hash function. (Inherited from Object)
| GetHeapInfo | Returns memory usage information.
| GetType | Gets the Type of the current instance. (Inherited from Object)
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object)
| ToString | Returns a string that represents the current object. (Inherited from Object)
| WriteHeapSnapshot | Writes a heap snapshot to the given stream.

Top
Events

| Name | Description
--- | --- | ---
| DebuggerConnected | Occurs when a debugger connects to a V8 runtime.
| DebuggerDisconnected | Occurs when a debugger disconnects from a V8 runtime.

Top
See Also

#### Reference

Microsoft.ClearScript.V8 Namespace

Copyright © Microsoft Corporation. All rights reserved.

Send comments on this topic to Microsoft