SkyOnNuget/Multi.Scriptingv2.0.0

Package Description:

Multi.Scripting provides classes and interfaces to run javascript code. It supplies a namespace structure to organise values and functions, allowing user specified data sources.

Further documentation on methods, properties, classes and interfaces may be found on the respective element as in-code summaries. (Due to a bug, the documentation was inaccessible before version 1.7.1! I apologize for the inconvinience and confusion.)

Notes on host types:

When a C# object is injected into the script, keep in mind that the type must be marked as public. Otherwise, member accessing may fail and throw an exception.

Notes on LINQ:

To use LINQ in your javascript code successfully, use the TypeRegistry class's AddLinq() method. Since LINQ pipelines may defer their execution, you may encounter an exception when returning an IEnumerable in the javascript code and attempting to enumerate it after the end of the V8ScriptEngine's lifespan. Unfortunately, due to a conflict with method overloads, all Enumerable.GroupBy overloads containing a resultSelector lack JSLINQ variants. Using a Enumerable.Select() may sufficiently replicate their behaviour. To use LINQ methods directly on javascript objects, you may use the Query class, which takes a params array or an IEnumerable as a constructor argument.

Notes on V8ScriptEngine's lifespan and MultiContinuation:

The V8ScriptEngine's lifespan is to be kept as short as possible for performance sake. For this reason, every method using the engine disposes of it as soon as it is done with it. This, of course, leads to its own problems (see above), which is why you may use methods exposing a MultiContinuation to further use the same instance of the engine for subsequent function invokations and more.

!! REMEMBER TO DISPOSE OF THE CONTINUATION ONCE YOU ARE DONE !!

Notes on disposable objects:

To make sure a disposable object is properly disposed in javascript code, it is recommended to use the extension method Use(). The Use() method takes a delegate as an argument and will dispose the object after the delegate has been invoked, or an exception was thrown. For objects which can be disposed asynchronously, there exists the UseAsync() method.

Notes on Clearscript:

The javascript execution is done through Clearscript. To simplify the construction of C#'s List and Dictionary classes, non-generic classes have been added, which inherit from the respectively equally named generic class. Similarly, Array.Empty<T>() may be achieved via the static Empty.Array method.