A common interface to a JavaScript engine. Every JavaScript engine is obtained from a IJavaScriptEnginePool and will be returned to the pool when it is disposed. Therefore, you must dispose the engine when you are done with it.

Namespace

Interfaces

IDisposable

Implementing Types

TestJsEngine

graph BT Type-.->Interface0["IDisposable"] Type["IJavaScriptEngine"] class Type type-node Implementing0["TestJsEngine"]-.->Type click Implementing0 "/api/Statiq.Testing.JavaScript/TestJsEngine"

Syntax

public interface IJavaScriptEngine : IDisposable

Properties

Name	Property Type	Summary
Name	string	Gets the name of JavaScript engine.
Version	string	Gets the version of original JavaScript engine.

Methods

Name	Return Value	Summary
CallFunction(string, object[])	object	Calls a JavaScript function.
CallFunction<T>(string, object[])	T	Calls a JavaScript function.
EmbedHostObject(string, object)	void	Embeds a host object to script code.
EmbedHostType(string, Type)	void	Embeds a host type to script code.
Evaluate(string)	object	Evaluates an expression.
Evaluate<T>(string)	T	Evaluates an expression.
Execute(string)	void	Executes JavaScript code.
ExecuteFile(string, Encoding)	void	Executes code from JavaScript file.
ExecuteResource(string, Assembly)	void	Executes code from embedded JavaScript resource.
ExecuteResource(string, Type)	void	Executes code from embedded JavaScript resource.
GetVariableValue(string)	object	Gets the value of variable.
GetVariableValue<T>(string)	T	Gets the value of variable.
HasVariable(string)	bool	Сhecks for the existence of a variable.
RemoveVariable(string)	void	Removes a variable.
SetVariableValue(string, object)	void	Sets the value of variable.

Extension Methods

Name	Value	Summary
ThrowIfNull<IJavaScriptEngine>(string)	T	From GuardExtensions
ToDocument<IJavaScriptEngine>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IJavaScriptEngine>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IJavaScriptEngine>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IJavaScriptEngine>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IJavaScriptEngine>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IJavaScriptEngine>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions