Node API for .NET

https://microsoft.github.io/node-api-dotnet
Admin
Node API for .NET enables advanced interoperability between .NET and JavaScript in the same process,...
Tokens:200,285
Snippets:1,413
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Initialize JavaScript Project and Install Dependencies

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-dynamic

Initializes a new JavaScript project if one doesn't exist and installs the 'node-api-dotnet' npm package, which facilitates the integration between JavaScript and .NET.

```shell
npm init
npm install node-api-dotnet
```

--------------------------------

### Example Output of JSRuntime Operations in C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/TracingJSRuntime

This example demonstrates the output format for various JSRuntime operations, including object creation, property definitions, wrapping objects, retrieving instance data, and callback information. The output shows the flow of data and object references during these operations.

```csharp
< CreateObject()
> CreateObject(000001E984E19BB0 object)
< DefineProperties(000001E984E19BB0 object, [hello(), toString()])
> DefineProperties(ok)
< Wrap(000001E984E19BB0 object, 0x000001E984CE4580 RuntimeType)
> Wrap(@000001E9808E7840 000001E984E19BF0 object)
< DefineProperties(000001E984E19B80 object, [Example])
> DefineProperties(ok)
< GetValueType(000001E984E19B80 object)
> GetValueType(object)
< GetInstanceData()
> GetInstanceData(0x000001E984CE1300 JSRuntimeContext)
< GetCallbackInfo(0000000CB8DFE560)
> GetCallbackInfo(1, 0x000001E984CE4590 JSPropertyDescriptor)
< GetCallbackArgs(0000000CB8DFE560, [1])
> GetCallbackArgs(0000000CB8DFE8C8 object, 0000000CB8DFE8D0 string ".NET")
```

--------------------------------

### JavaScript / .NET Namespace Access Example

Source: https://microsoft.github.io/node-api-dotnet/reference/js-dotnet-types

Demonstrates how to access .NET namespaces and their members from JavaScript using the `node-api-dotnet` module. This example shows calling `Console.WriteLine` from the `System` namespace.

```javascript
import dotnet from 'node-api-dotnet';

dotnet.System.Console.WriteLine()
```

--------------------------------

### JSAsyncScope Usage Example

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/JSAsyncScope

Demonstrates how to use the JSAsyncScope struct to manage asynchronous operations within a Node.js process.

```APIDOC
## Usage Example

### C#
```csharp
public async void RunAsyncTask(JSDeferred deferred, int id)
{
    // We must use 'using' keyword to call 'Dispose' in the end.
    using var asyncScope = new JSAsyncScope();

    var data = await RetriveDataById(id);
    deferred.Resolve((JSValue)data.FullName);
}
```

**Explanation**: The `using` statement ensures that `JSAsyncScope.Dispose()` is called automatically when the block is exited, which in turn calls `JSSynchronizationContext.Current.CloseAsyncScope()`. This tells the Node.js process that it can exit once the current callback is completed if no other work is pending.
```

--------------------------------

### JSExportAttribute Usage Examples

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSExportAttribute

Demonstrates how to use the JSExportAttribute to control JavaScript exports for assemblies, classes, and methods. Shows how attributes at different levels override each other.

```csharp
// Export all public types in the current assembly (unless otherwise specified).
[assembly: JSExport]

// This type is not exported. The type-level attribute overrides the assembly-level attribute.
[JSExport(false)]
public static class NonExportedClass
{
    // This method is exported as a static method on the module (not on the unexported class).
    // The member-level attribute overrides any class or assembly-level attributes.
    [JSExport]
    public static void ModuleMethod();
}

// Without a type-level attribute, public types are exported by the assembly-level attribute.
public class ExportedClass
{
    // The member-level attribute overrides any class or assembly-level attributes.
    [JSExport(false)]
    public void NonExportedMethod() {}

    // Without a member-level attribute, public members are exported along with the type.
    public void ExportedMethod() {}
}
```

--------------------------------

### Guid Conversion

Source: https://microsoft.github.io/node-api-dotnet/reference/other-types

Details how .NET's Guid type is marshalled to a JavaScript string and how marshalling from JavaScript to .NET Guid is supported.

```APIDOC
## Guid Conversion

### Description

This section covers the conversion of .NET's `Guid` type to a JavaScript `string` and vice versa. By default, .NET `Guid` is represented as a string in the standard "D" format in JavaScript.

### C# Type
`Guid`

### JS Type
`string`

### Details

- A .NET `Guid` is marshalled to JavaScript as a `string` using the default "D" format.
- Marshalling from JavaScript to .NET supports any string format that can be parsed by `Guid.Parse()`.
```

--------------------------------

### Initialize Node.js Runtime in .NET

Source: https://microsoft.github.io/node-api-dotnet/scenarios/dotnet-js

This C# code snippet demonstrates how to load the libnode binary and initialize a Node.js platform and runtime instance. It requires the `Microsoft.JavaScript.LibNode` NuGet package. The `libnodePath` should point to the correct binary, and the `MainScript` can be used to set up global JavaScript variables.

```csharp
string baseDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)!;
string libnodePath = Path.Combine(baseDir, "libnode.dll");
NodeEmbeddingPlatform nodejsPlatform = new(libnodePath, null);
NodeEmbeddingThreadRuntime nodejsRuntime = nodejsPlatform.CreateThreadRuntime(baseDir,
    new NodeEmbeddingRuntimeSettings
    {
        MainScript =
            "globalThis.require = require('module').createRequire(process.execPath);\n"
    });
```

--------------------------------

### JSTypedArray Constructor (T[] data, int start, int length)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSTypedArray-1/JSTypedArray

Creates a typed-array over an array, without copying, starting at a specific index and with a specified length.

```APIDOC
## JSTypedArray<T> constructor (T[] data, int start, int length)

### Description
Creates a typed-array over an array, without copying, starting at a specific index and with a specified length.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
// Assuming T is a specific type like short
short[] dataArray = { 10, 20, 30, 40, 50 };
var typedArray = new JSTypedArray<short>(dataArray, 1, 3); // Creates a typed array from elements at index 1, 2, and 3
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### NodejsRuntime.node_embedding_platform_configure_callback Constructor (1 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_platform_configure_callback/node_embedding_platform_configure_callback

Initializes a new instance of the NodejsRuntime.node_embedding_platform_configure_callback struct using a delegate.

```APIDOC
## NodejsRuntime.node_embedding_platform_configure_callback Constructor (1 of 2)

### Description
Initializes a new instance of the NodejsRuntime.node_embedding_platform_configure_callback struct using a delegate.

### Method
Constructor

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public node_embedding_platform_configure_callback(Delegate callback)
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### NodejsRuntime.node_embedding_platform_configure_callback Constructor (2 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_platform_configure_callback/node_embedding_platform_configure_callback

Initializes a new instance of the NodejsRuntime.node_embedding_platform_configure_callback struct using a handle.

```APIDOC
## NodejsRuntime.node_embedding_platform_configure_callback Constructor (2 of 2)

### Description
Initializes a new instance of the NodejsRuntime.node_embedding_platform_configure_callback struct using a handle.

### Method
Constructor

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public node_embedding_platform_configure_callback(IntPtr Handle)
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### Create .NET Class Library Project

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-module

Initializes a new .NET class library project targeting .NET 8. This command sets up the basic structure for the Node.js addon module.

```shell
mkdir ExampleModule
cd ExampleModule
dotnet new classlib --framework net8.0
```

--------------------------------

### Set and Get WorkerData with C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/NodeWorker.Options/WorkerData

The WorkerData property allows you to set any JavaScript value to be cloned and made available as CurrentWorkerData within the .NET worker. The structured clone algorithm is used, and errors are thrown for non-clonable objects like functions. It is of type JSValue? and can be accessed via get and set.

```csharp
public JSValue? WorkerData { get; set; }
```

--------------------------------

### TracingJSRuntime.EmbeddingRunRuntime Method

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/TracingJSRuntime/EmbeddingRunRuntime

Configures and runs the node embedding runtime.

```APIDOC
## TracingJSRuntime.EmbeddingRunRuntime Method

### Description
This method configures and initiates the node embedding runtime, allowing for JavaScript execution within the .NET environment.

### Method
`public override NodeEmbeddingStatus EmbeddingRunRuntime(node_embedding_platform platform, node_embedding_runtime_configure_callback configure_runtime, IntPtr configure_runtime_data)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
// Example usage:
NodeEmbeddingStatus status = tracingJSRuntime.EmbeddingRunRuntime(platform, configure_runtime, configure_runtime_data);
```

### Response
#### Success Response (200)
- **NodeEmbeddingStatus** (enum) - Indicates the status of the runtime embedding operation.

#### Response Example
```json
{
  "status": "Success"
}
```

### See Also
- enum NodeEmbeddingStatus
- struct node_embedding_platform
- struct node_embedding_runtime_configure_callback
- class TracingJSRuntime
- namespace Microsoft.JavaScript.NodeApi.Runtime
```

--------------------------------

### Build JS Property Get Expression - C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/JSMarshaller/BuildFromJSPropertyGetExpression

Builds a lambda expression for a JS callback adapter to a .NET property getter. When invoked, the expression will get the property value and marshal it back to JS. The returned expression takes a single JSCallbackArgs parameter and returns a JSValue. For instance methods, the `this` argument for the JS callback args must be a JS object that wraps a .NET object matching the property's declaring type.

```csharp
public Expression<JSCallback> BuildFromJSPropertyGetExpression(PropertyInfo property)
```

--------------------------------

### ManagedHost Initialization and Utilities (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/ManagedHost

Provides static methods for initializing the managed host module and retrieving .NET runtime information. InitializeModule is called by the native host to set up the managed host instance.

```csharp
public ManagedHost(JSContext context);
public static bool IsTracingEnabled { get; }
public static string GetFrameworkMoniker(Assembly assembly);
public static string GetRuntimeVersion(Assembly assembly);
public static object InitializeModule(JSContext context, JSObject exports);
public static void Trace(string message);
public static void TraceDebug(string message);
```

--------------------------------

### Configure .NET Project for Node-API-Dotnet

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-dynamic

This .csproj file manages NuGet packages and .NET assemblies for JavaScript interop. It specifies the target framework, output directory, and includes necessary package references and project references. Ensure referenced projects have `<GenerateDocumentationFile>true</GenerateDocumentationFile>` for doc-comment generation.

```xml
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <OutDir>bin</OutDir>
    <NodeApiAssemblyJSModuleType>commonjs</NodeApiAssemblyJSModuleType>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.5.*" />
    <PackageReference Include="Example.Package" Version="1.2.3" />
    <ProjectReference Include="../ClassLib/ClassLib.csproj" />
  </ItemGroup>
</Project>
```

--------------------------------

### JSArray.CopyTo(JSValue[] array, int arrayIndex)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSArray/CopyTo

Copies JSArray elements to a destination JSValue array, starting at the specified index.

```APIDOC
## JSArray.CopyTo(JSValue[] array, int arrayIndex)

### Description
Copies elements from the JSArray to a destination array of JSValue.

### Method
`void`

### Endpoint
N/A (Method documentation)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```csharp
public void CopyTo(JSValue[] array, int arrayIndex)
```

### Response
#### Success Response (void)
N/A

#### Response Example
N/A

### See Also
* struct JSValue
* struct JSArray
* namespace Microsoft.JavaScript.NodeApi
```

--------------------------------

### Initialize napi_async_cleanup_hook with Delegate (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.napi_async_cleanup_hook/napi_async_cleanup_hook

This constructor initializes a new instance of the napi_async_cleanup_hook class using a provided Delegate callback. It is used to set up an asynchronous cleanup hook in the Node.js runtime. No specific dependencies are mentioned other than the Delegate type itself.

```csharp
public napi_async_cleanup_hook(Delegate callback)
```

--------------------------------

### JSValueScope.EnvironmentHandle Property

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValueScope/EnvironmentHandle

Gets the environment handle for the scope. This property will throw an exception if the scope has been disposed or if accessed from an invalid thread.

```APIDOC
## JSValueScope.EnvironmentHandle Property

### Description
Gets the environment handle for the scope, or throws an exception if the scope is disposed or access from the current thread is invalid.

### Method
GET

### Endpoint
N/A (Property Access)

### Parameters
N/A

### Request Example
N/A (Property Access)

### Response
#### Success Response (200)
- **EnvironmentHandle** (napi_env) - The environment handle for the scope.

#### Response Example
```csharp
// Assuming 'scope' is an instance of JSValueScope
napi_env env = scope.EnvironmentHandle;
```

## Exceptions

| Exception Type             | Condition                       |
|----------------------------|---------------------------------|
| JSValueScopeClosedException| The scope has been closed.      |
| JSInvalidThreadAccessException | The scope is not valid on the current thread. |
```

--------------------------------

### JSValue.Handle Property

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValue/Handle

Gets the value handle of a JSValue. Throws an exception if the value scope is disposed or accessed from an invalid thread.

```APIDOC
## JSValue.Handle Property

### Description
Gets the value handle, or throws an exception if the value scope is disposed or access from the current thread is invalid.

### Method
GET

### Endpoint
N/A (Property Access)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Handle** (napi_value) - The value handle.

#### Response Example
```csharp
public napi_value Handle { get; }
```

## Exceptions 
### JSValueScopeClosedException
- **Condition**: The scope has been closed.

### JSInvalidThreadAccessException
- **Condition**: The scope is not valid on the current thread.
```

--------------------------------

### JSFunction.As<T> Method Documentation

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSFunction/As

Documentation for the JSFunction.As<T> method, explaining its purpose, parameters, and return value.

```APIDOC
## JSFunction.As<T> Method

### Description
Tries to create a T struct from this instance. It returns `null` if the T struct cannot be created.

### Method Signature
```csharp
public T? As<T>()
    where T : struct, IJSValue<T>
```

### Parameters
#### Type Parameters
- **T** (struct) - A struct that implements the `IJSValue` interface.

### Return Value
A nullable value of type `T` that contains the struct if it was successfully created, or `null` if the creation failed.

### See Also
- interface `IJSValue<TSelf>`
- struct `JSFunction`
- namespace `Microsoft.JavaScript.NodeApi`
```

--------------------------------

### Add node-api-dotnet npm Package

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-module

Installs the `node-api-dotnet` npm package into the Node.js project. This package serves as the bridge between JavaScript and the .NET runtime.

```shell
npm install node-api-dotnet
```

--------------------------------

### JSMarshaller.GetToJSValueDelegate Method (Generic)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/JSMarshaller/GetToJSValueDelegate

Gets a delegate that converts from a specified type to a JS value using generics. This method leverages caching for efficiency.

```APIDOC
## JSMarshaller.GetToJSValueDelegate<T> ()<T>

### Description
Gets a delegate that converts from a specified type to a JS value. Type conversion delegates are built on demand and then cached, so it is efficient to call this method multiple times for the same type.

### Method
`public From<T> GetToJSValueDelegate<T>()`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
// Example usage:
// var converter = JSMarshaller.GetToJSValueDelegate<MyClass>();
```

### Response
#### Success Response (200)
- **From<T>** (Delegate) - A delegate of type `From<T>` that converts the type `T` to a JS value.

#### Response Example
```json
// A From<T> delegate object would be returned, specific to the generic type T.
```

### Exceptions
- **NotSupportedException** - The type cannot be converted.
```

--------------------------------

### JSSet Constructors

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSSet

Details on how to create new JSSet instances, either empty or initialized with values from an iterable.

```APIDOC
## JSSet Constructors

### Description
Provides methods for creating new `JSSet` objects.

### Public Members

- **JSSet()**: Creates a new empty `JSSet`.
- **JSSet(IEnumerable<JSValue>)**: Creates a new `JSSet` with values from an iterable (such as another set).
```

--------------------------------

### JSMarshaller.GetToJSValueDelegate Method (Non-Generic)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/JSMarshaller/GetToJSValueDelegate

Gets a delegate that converts from a specified type to a JS value. This method is efficient due to on-demand delegate building and caching.

```APIDOC
## JSMarshaller.GetToJSValueDelegate (Type type)

### Description
Gets a delegate that converts from a specified type to a JS value. Type conversion delegates are built on demand and then cached, so it is efficient to call this method multiple times for the same type.

### Method
`public Delegate GetToJSValueDelegate(Type type)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
// Example usage:
// Delegate converter = JSMarshaller.GetToJSValueDelegate(typeof(MyClass));
```

### Response
#### Success Response (200)
- **Delegate** (Delegate) - A delegate that converts the specified type to a JS value.

#### Response Example
```json
// A Delegate object would be returned, specific type depends on the input 'type'.
```

### Exceptions
- **NotSupportedException** - The type cannot be converted.
```

--------------------------------

### Get JSReference Handle (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSReference/Handle

Retrieves the value handle of a JavaScript reference. Throws an exception if accessed from an invalid thread or if the reference is disposed.

```csharp
public napi_ref Handle { get; }
```

--------------------------------

### TypeExporter Constructor

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/TypeExporter/TypeExporter

Explains the creation of a new TypeExporter instance and its parameters.

```APIDOC
## TypeExporter Constructor

### Description
Creates a new instance of the `TypeExporter` class.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### See Also
* class JSMarshaller
* struct JSObject
* class TypeExporter
* namespace Microsoft.JavaScript.NodeApi.DotNetHost
```

--------------------------------

### JSReference.TryGetValue Method

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSReference/TryGetValue

Attempts to get the referenced JS value from a JSReference. Returns true if the value was obtained, and false if the reference is weak and the value is not available.

```APIDOC
## JSReference.TryGetValue Method

### Description
Attempts to get the referenced JS value. Returns true if the value was obtained, and false if the reference is weak and the value is not available.

### Method
`bool TryGetValue(out JSValue value)`

### Parameters
#### Output Parameters
- **value** (JSValue) - The referenced JS value, or `default(JSValue)` (equivalent to `undefined`) if the reference is weak and the value is not available.

### Return Value
`True` if the value was obtained, `false` if the reference is weak and the value is not available.

### Exceptions
- **ObjectDisposedException** - The reference is disposed.

### See Also
- struct `JSValue`
- class `JSReference`
- namespace `Microsoft.JavaScript.NodeApi`
```

--------------------------------

### JSCallbackDescriptor Constructor (2 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/JSCallbackDescriptor/JSCallbackDescriptor

Initializes a new instance of the JSCallbackDescriptor struct with a specified name, JavaScript callback, and optional data.

```APIDOC
## JSCallbackDescriptor Constructor (2 of 2)

### Description
Initializes a new instance of the JSCallbackDescriptor struct with a specified name, JavaScript callback, and optional data.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public JSCallbackDescriptor(string? name, JSCallback callback, object? data = null)
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Access .NET Types and Methods

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-dynamic

Demonstrates how to create aliases for .NET types and namespaces to simplify access. It shows creating instances of .NET classes, calling static methods, and accessing properties, with automatic type marshalling between JavaScript and .NET.

```javascript
const ExampleStaticClass = dotnet.ExampleNamespace.ExampleStaticClass;
const ExampleClass = dotnet.ExampleNamespace.ExampleClass;
ExampleStaticClass.ExampleMethod();
const exampleObj = new ExampleClass(...args);
```

--------------------------------

### JSArray.CopyTo Method (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSArray/CopyTo

Copies the entire JSArray to a compatible one-dimensional array, starting at the specified index of the destination array. This method does not support array ranges.

```csharp
public void CopyTo(JSValue[] array, int arrayIndex)
```

--------------------------------

### JSPropertyDescriptor constructor (string name)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSPropertyDescriptor/JSPropertyDescriptor

Creates a property descriptor with a string name.

```APIDOC
## JSPropertyDescriptor constructor (string name)

### Description
Creates a property descriptor with a string name.

### Method
`public JSPropertyDescriptor(string name, JSCallback? method = null, JSCallback? getter = null, JSCallback? setter = null, JSValue? value = default, JSPropertyAttributes attributes = JSPropertyAttributes.Default, object? data = null)`

### Parameters
This constructor does not have explicit path, query, or body parameters in the traditional sense. The parameters listed in the method signature are part of the C# constructor overload.

- `name` (string) - The string name of the property.
- `method` (JSCallback?) - Optional callback for a method property.
- `getter` (JSCallback?) - Optional callback for a getter.
- `setter` (JSCallback?) - Optional callback for a setter.
- `value` (JSValue?) - Optional value for the property.
- `attributes` (JSPropertyAttributes) - Optional attributes for the property descriptor.
- `data` (object?) - Optional data associated with the descriptor.

### Request Example
This is a C# constructor, so a direct request example in the typical API sense is not applicable. However, it would be used within C# code like so:
```csharp
var descriptor = new JSPropertyDescriptor("myStringProperty", JSValue.True);
```

### Response
#### Success Response
N/A - This is a constructor, not an API endpoint returning data.

#### Response Example
N/A
```

--------------------------------

### Get JSValue Handle in C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValue/Handle

The Handle property in C# retrieves the value handle. It throws JSValueScopeClosedException if the scope is closed or JSInvalidThreadAccessException if accessed from an invalid thread.

```csharp
public napi_value Handle { get; }
```

--------------------------------

### Export C# Types for JavaScript

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-dotnet-module

Defines a C# class `Example` and marks it with the `[JSExport]` attribute. This attribute signals to the generator that this type, along with its public members, should be exported to JavaScript.

```csharp
using Microsoft.JavaScript.NodeApi;

[JSExport]
public class Example
{
}
```

--------------------------------

### NodejsRuntime.node_embedding_runtime_loaded_callback Constructor (IntPtr overload)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_runtime_loaded_callback/node_embedding_runtime_loaded_callback

Initializes a new instance of the NodejsRuntime.node_embedding_runtime_loaded_callback structure using an IntPtr.

```APIDOC
## NodejsRuntime.node_embedding_runtime_loaded_callback constructor

### Description
Initializes a new instance of the NodejsRuntime.node_embedding_runtime_loaded_callback structure using an IntPtr.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public node_embedding_runtime_loaded_callback(IntPtr Handle)
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### TracingJSRuntime.GetValueBigInt64 (1 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/TracingJSRuntime/GetValueBigInt64

Retrieves a 64-bit signed integer value from a napi_value.

```APIDOC
## TracingJSRuntime.GetValueBigInt64 (1 of 2)

### Description
Retrieves a 64-bit signed integer value from a napi_value.

### Method
(Implicitly a getter or conversion method, no explicit HTTP method)

### Endpoint
(N/A - This is a C# method signature)

### Parameters
#### Path Parameters
(N/A)

#### Query Parameters
(N/A)

#### Request Body
(N/A)

### Request Example
(N/A - This is a C# method signature)

### Response
#### Success Response (200)
- **result** (long) - The 64-bit signed integer value.
- **lossless** (bool) - Indicates if the conversion was lossless.

#### Response Example
(N/A - This is a C# method signature)
```

--------------------------------

### JSValue Property Manipulation in C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValue

Details methods for getting and setting properties of a JSValue. This includes accessing specific properties, defining multiple properties at once, and retrieving all property names.

```csharp
// Gets a property by name
public JSValue GetProperty(string propertyName);

// Sets a property by name
public void SetProperty(string propertyName, JSValue value);

// Defines multiple properties on the JSValue
public void DefineProperties(JSValue propertiesDefinition);

// Gets all own property names of the JSValue
public JSValue GetPropertyNames();
```

--------------------------------

### Initialize napi_async_cleanup_hook with IntPtr Handle (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.napi_async_cleanup_hook/napi_async_cleanup_hook

This constructor initializes a new instance of the napi_async_cleanup_hook class using an IntPtr Handle. This is typically used when dealing with lower-level unmanaged resources or existing handles within the Node.js runtime. The input is an unmanaged pointer.

```csharp
public napi_async_cleanup_hook(IntPtr Handle)
```

--------------------------------

### JavaScript / .NET Special Type Mappings

Source: https://microsoft.github.io/node-api-dotnet/reference/js-dotnet-types

Covers the mapping of other specialized .NET types to JavaScript. `Guid` is mapped to a string, and `BigInteger` to JavaScript's `bigint` type.

```markdown
Other special types| .NET `Guid` => JS `string`  
.NET `BigInteger` => JS `bigint`  
```

--------------------------------

### Get SynchronizationContext - C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodeEmbeddingThreadRuntime/SynchronizationContext

Retrieves a JSSynchronizationContext object that allows switching to and from the Node.js environment's thread. This is essential for executing JavaScript operations within the Node.js event loop from .NET.

```csharp
public JSSynchronizationContext SynchronizationContext { get; }
```

--------------------------------

### JSCallbackDescriptor Constructor (1 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/JSCallbackDescriptor/JSCallbackDescriptor

Initializes a new instance of the JSCallbackDescriptor struct with a specified JavaScript callback and optional data.

```APIDOC
## JSCallbackDescriptor Constructor (1 of 2)

### Description
Initializes a new instance of the JSCallbackDescriptor struct with a specified JavaScript callback and optional data.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public JSCallbackDescriptor(JSCallback callback, object? data = null)
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### C# napi_async_complete_callback Constructor with Delegate

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.napi_async_complete_callback/napi_async_complete_callback

Initializes a new instance of the napi_async_complete_callback struct using a Delegate. This constructor is part of the Node API for .NET, enabling interaction between .NET and Node.js.

```csharp
public napi_async_complete_callback(Delegate callback)
```

--------------------------------

### Get Environment Handle - C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValueScope/EnvironmentHandle

Retrieves the environment handle for the current JSValueScope. This property will throw a JSValueScopeClosedException if the scope has been closed or a JSInvalidThreadAccessException if accessed from an invalid thread. It returns a napi_env type.

```csharp
public napi_env EnvironmentHandle { get; }
```

--------------------------------

### Create JSTypedArray<T> from T[] Array with Offset (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSTypedArray-1/JSTypedArray

Creates a JSTypedArray<T> that wraps a portion of an existing T[] array, specified by a starting index and length, without copying. This provides flexibility in referencing parts of an array.

```csharp
public JSTypedArray(T[] data, int start, int length)
```

--------------------------------

### C# Constructor for node_embedding_platform_configure_callback with IntPtr

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_platform_configure_callback/node_embedding_platform_configure_callback

Initializes a new instance of the node_embedding_platform_configure_callback struct using an IntPtr. This constructor is typically used for lower-level interop scenarios where a raw handle to the Node.js embedding platform is available.

```csharp
public node_embedding_platform_configure_callback(IntPtr Handle)
```

--------------------------------

### JSArray.CopyTo<T> Method (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSArray/CopyTo

Copies the entire JSArray to a compatible one-dimensional array, starting at the specified index of the destination array, using a provided conversion delegate. This method does not support array ranges.

```csharp
public void CopyTo<T>(T[] array, int arrayIndex, To<T> fromJS)
```

--------------------------------

### NodejsRuntime.node_embedding_runtime_loaded_callback Constructor (Delegate overload)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_runtime_loaded_callback/node_embedding_runtime_loaded_callback

Initializes a new instance of the NodejsRuntime.node_embedding_runtime_loaded_callback structure using a delegate.

```APIDOC
## NodejsRuntime.node_embedding_runtime_loaded_callback constructor

### Description
Initializes a new instance of the NodejsRuntime.node_embedding_runtime_loaded_callback structure using a delegate.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public node_embedding_runtime_loaded_callback(Delegate callback)
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### JSMap Constructor (1 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSMap/JSMap

Creates a new empty JS Map.

```APIDOC
## JSMap Constructor (1 of 2)

### Description
Creates a new empty JS Map.

### Method
`public JSMap()`

### Endpoint
N/A (Constructor)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (N/A for constructors)
N/A

#### Response Example
N/A
```

--------------------------------

### NodeEmbeddingThreadRuntime.SynchronizationContext

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodeEmbeddingThreadRuntime/SynchronizationContext

Gets a synchronization context that enables switching to the Node.js environment's thread and returning to the thread after an await. All interaction with the environment and JavaScript values must be executed on the environment's thread.

```APIDOC
## NodeEmbeddingThreadRuntime.SynchronizationContext Property

### Description
Gets a synchronization context that enables switching to the Node.js environment's thread and returning to the thread after an `await`.

### Method
GET

### Endpoint
`/websites/microsoft_github_io_node-api-dotnet/NodeEmbeddingThreadRuntime/SynchronizationContext`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **SynchronizationContext** (JSSynchronizationContext) - The synchronization context for the Node.js environment.

#### Response Example
```json
{
  "SynchronizationContext": { /* JSSynchronizationContext object */ }
}
```
```

--------------------------------

### NodeEmbeddingRuntime Class Definition (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodeEmbeddingRuntime

Defines the NodeEmbeddingRuntime class, which implements IDisposable to manage a Node.js environment within a .NET process. It includes methods for starting, stopping, and interacting with the Node.js event loop.

```csharp
public sealed class NodeEmbeddingRuntime : IDisposable
```

--------------------------------

### C# Nullable Conversions with JSValue

Source: https://microsoft.github.io/node-api-dotnet/reference/basic-types

Illustrates how nullable conversions are supported for .NET types when interacting with JavaScript's null and undefined values. It shows conversions between .NET nullables and JS null/undefined, and vice versa.

```csharp
JSValue maybeJsString = JSValue.Null;
string? maybeString = (string?)maybeJsString; // JS null => .NET null
JSValue maybeJsString2 = maybeString; // .NET null => JS undefined

JSValue maybeJsNumber = JSValue.Undefined;
int? maybeInt = (int?)maybeJsNumber; // JS undefined => .NET null
JSValue maybeJsNumber2 = maybeInt; // .NET null => JS undefined
```

--------------------------------

### Initialize NodeEmbeddingPlatform with Settings (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodeEmbeddingPlatform/NodeEmbeddingPlatform

This C# code snippet shows how to initialize the NodeEmbeddingPlatform by providing an optional NodeEmbeddingPlatformSettings object. The constructor takes a path to the 'libnode' shared library and platform settings. An InvalidOperationException is thrown if a Node.js platform is already loaded in the process.

```csharp
public NodeEmbeddingPlatform(NodeEmbeddingPlatformSettings? settings)
```

--------------------------------

### Get .NET Runtime Information (TypeScript)

Source: https://microsoft.github.io/node-api-dotnet/reference/js

Retrieves information about the currently loaded .NET runtime. The `frameworkMoniker` property returns the target framework (e.g., 'net8.0'), and `runtimeVersion` provides the specific version (e.g., '8.0.1').

```typescript
const framework: string = dotnet.frameworkMoniker;
const version: string = dotnet.runtimeVersion;
```

--------------------------------

### NodejsRuntime.napi_addon_register_func Constructor (Delegate) in C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.napi_addon_register_func/napi_addon_register_func

This constructor for napi_addon_register_func takes a Delegate callback as an argument. It is used to register a JavaScript function that can be called from Node.js. Ensure the delegate matches the expected signature for Node-API callbacks.

```csharp
public napi_addon_register_func(Delegate callback)
```

--------------------------------

### Getting Full .NET Type Names in JavaScript

Source: https://microsoft.github.io/node-api-dotnet/reference/generics

Shows how to retrieve the full .NET type name for generic, specialized generic, and non-generic types using the `toString()` method on their JavaScript projections.

```JavaScript
// JavaScript
System.Comparer$.toString();                  // 'System.Comparer<T>'
System.Comparer$(System.DateTime).toString(); // 'System.Comparer<System.DateTime>'
System.String.toString();                     // 'System.String'
```

--------------------------------

### Getting the Referenced JS Value (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSReference

Illustrates methods for retrieving the JavaScript value held by a JSReference. GetValue() retrieves the value directly, while TryGetValue() attempts retrieval and returns a boolean indicating success.

```csharp
public JSValue GetValue();
```

```csharp
public bool TryGetValue(out JSValue value);
```

--------------------------------

### TracingJSRuntime.GetValueBigInt64 (2 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/TracingJSRuntime/GetValueBigInt64

Retrieves a 64-bit unsigned integer value from a napi_value.

```APIDOC
## TracingJSRuntime.GetValueBigInt64 (2 of 2)

### Description
Retrieves a 64-bit unsigned integer value from a napi_value.

### Method
(Implicitly a getter or conversion method, no explicit HTTP method)

### Endpoint
(N/A - This is a C# method signature)

### Parameters
#### Path Parameters
(N/A)

#### Query Parameters
(N/A)

#### Request Body
(N/A)

### Request Example
(N/A - This is a C# method signature)

### Response
#### Success Response (200)
- **result** (ulong) - The 64-bit unsigned integer value.
- **lossless** (bool) - Indicates if the conversion was lossless.

#### Response Example
(N/A - This is a C# method signature)
```

--------------------------------

### JSCallbackOverload.DefaultValues Property Access

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/JSCallbackOverload/DefaultValues

Accessing the DefaultValues property of a JSCallbackOverload to get an array of default parameter values. The array's length corresponds to the number of parameters with default values, and its indices are offset from the ParameterTypes array.

```APIDOC
## GET /websites/microsoft_github_io_node-api-dotnet/JSCallbackOverload/DefaultValues

### Description
Retrieves the array of default parameter values for the JSCallbackOverload. If no parameters have default values, this property returns null.

### Method
GET

### Endpoint
/websites/microsoft_github_io_node-api-dotnet/JSCallbackOverload/DefaultValues

### Parameters
This endpoint does not take any parameters.

### Request Example
```json
{
  "example": "No request body needed for accessing property."
}
```

### Response
#### Success Response (200)
- **DefaultValues** (object?[]? | null) - An array containing the default values for the parameters. The order and offset from `ParameterTypes` are detailed in the remarks.

#### Response Example
```json
{
  "DefaultValues": [
    null,
    null,
    "default_value_for_param_3",
    123
  ]
}
```

## Remarks 
Defaults are always at the end of the list of parameters, so if a method has 2 default parameters then this array length would be 2. Therfore, the indexes in this array are offset from the `ParameterTypes` array by the number of non-default parameters.

## See Also 
  * struct JSCallbackOverload
  * namespace Microsoft.JavaScript.NodeApi.Interop
```

--------------------------------

### C# Constructor for node_embedding_platform_configure_callback with Delegate

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_platform_configure_callback/node_embedding_platform_configure_callback

Initializes a new instance of the node_embedding_platform_configure_callback struct with a specified delegate. This constructor is used to provide a callback function from the .NET environment to the Node.js runtime.

```csharp
public node_embedding_platform_configure_callback(Delegate callback)
```

--------------------------------

### Get CurrentWorkerData C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Interop/NodeWorker/CurrentWorkerData

Retrieves an arbitrary JavaScript value that is a clone of the data passed to the current thread's Worker constructor. This property requires a JavaScript scope to be established for the current thread, otherwise a JSInvalidThreadAccessException is thrown.

```csharp
public static JSValue CurrentWorkerData { get; }
```

--------------------------------

### Microsoft.JavaScript.NodeApi Namespace Overview

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi

This section provides an overview of the types within the Microsoft.JavaScript.NodeApi namespace, including their descriptions and purposes.

```APIDOC
## Microsoft.JavaScript.NodeApi Namespace

This namespace provides types for interacting with JavaScript from .NET.

### Interfaces
- **IJSValue<TSelf>** (interface): A base interface for structs representing JavaScript values or built-in object types.

### Delegates
- **JSActionCallback** (delegate): Represents a low-level void function or method call/callback from JavaScript into .NET.
- **JSCallback** (delegate): Represents a low-level function or method call/callback from JavaScript into .NET.

### Structs
- **JSArray** (struct): Represents a JavaScript Array.
- **JSAsyncIterable** (struct): Represents a JavaScript Async Iterable.
- **JSBigInt** (struct): Represents a JavaScript BigInt.
- **JSCallbackArgs** (struct): Provides access to arguments for JavaScript function calls/callbacks, including the `this` argument and context.
- **JSDate** (struct): Represents a JavaScript Date.
- **JSError** (struct): Represents a JavaScript Error.
- **JSFunction** (struct): Represents a JavaScript Function value.
- **JSIterable** (struct): Represents a JavaScript Iterable.
- **JSMap** (struct): Represents a JavaScript Map.
- **JSObject** (struct): Represents a JavaScript Object.
- **JSPromise** (struct): Represents a JavaScript Promise object.
- **JSPropertyDescriptor** (struct): Describes a property of a JavaScript object (name, value, attributes).
- **JSProxy** (struct): Enables creation of JS Proxy objects with C# handler callbacks.
- **JSReference** (struct): A strong or weak reference to a JS value.
- **JSSet** (struct): Represents a JavaScript Set.
- **JSSymbol** (struct): Represents a JavaScript Symbol.
- **JSTypedArray<T>** (struct): Represents a JavaScript Typed Array.
- **JSValue** (struct): Represents a generic JavaScript value.

### Enums
- **JSErrorType** (enum): Enumerates types of JavaScript errors.
- **JSPropertyAttributes** (enum): Flags for JavaScript property attributes.
- **JSTypedArrayType** (enum): Enumerates types of JavaScript Typed Arrays.
- **JSValueScopeType** (enum): Indicates the type of `JSValueScope` within the hierarchy.
- **JSValueType** (enum): Enumerates JavaScript value types.

### Classes
- **JSDispatcherQueue** (class): Manages dispatching tasks.
- **JSDispatcherQueueController** (class): Controls the JSDispatcherQueue.
- **JSDispatcherQueueTimer** (class): Represents a timer for JSDispatcherQueue.
- **JSEventEmitter** (class): Event emitter backed by Node.js EventEmitter or a runtime-agnostic tracker.
- **JSException** (class): Exception caused by JavaScript errors or interactions.
- **JSExportAttribute** (class): Exports items to JavaScript.
- **JSImportAttribute** (class): Indicates a class or struct imported from JavaScript.
- **JSInvalidThreadAccessException** (class): Exception for accessing JS values on an invalid thread.
- **JSValueScope** (class): Controls the lifetime of JS values.
- **JSValueScopeClosedException** (class): Exception when accessing JS values after scope closure.

### Static Classes
- **NodeApiStatusExtensions** (static class): Extension methods for NodeApi status.
- **TaskExtensions** (static class): Extension methods for converting .NET tasks and JS promises.
```

--------------------------------

### JSSet Equality and Comparison in C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSSet

Illustrates how JSSet instances are compared for equality using JS 'strict' equality. This includes overloaded equality operators and the Equals method.

```csharp
public override bool Equals(object? obj);
public bool Equals(JSSet other);
public static bool operator ==(JSSet left, JSSet right);
public static bool operator !=(JSSet left, JSSet right);
```

--------------------------------

### Get JS Value Conversion Expression (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/JSMarshaller/GetFromJSValueExpression

Retrieves a lambda expression for converting JavaScript values to a specified .NET type. This method caches conversion expressions for efficiency. It may throw a NotSupportedException if the type cannot be converted.

```csharp
public LambdaExpression GetFromJSValueExpression(Type toType)
{
    // Implementation details are not provided in the input text.
    // This is a placeholder for the actual method signature.
    throw new System.NotImplementedException();
}
```

--------------------------------

### TracingJSRuntime.EmbeddingRuntimeConfigOnLoading Method

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/TracingJSRuntime/EmbeddingRuntimeConfigOnLoading

This method overrides the base implementation to embed the runtime configuration when the runtime is loading. It handles the configuration, loading callback, and data release.

```APIDOC
## TracingJSRuntime.EmbeddingRuntimeConfigOnLoading Method

### Description
Overrides the base implementation to embed the runtime configuration during the loading process. This method is crucial for initializing the JavaScript runtime with necessary configurations and callbacks.

### Method
```csharp
public override NodeEmbeddingStatus EmbeddingRuntimeConfigOnLoading(
    node_embedding_runtime_config runtime_config,
    node_embedding_runtime_loading_callback run_load,
    IntPtr load_data,
    node_embedding_data_release_callback release_load_data
)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (NodeEmbeddingStatus)
- **NodeEmbeddingStatus** (enum) - Indicates the status of the runtime configuration embedding operation.

#### Response Example
None
```

--------------------------------

### Require .NET Native Module in JavaScript (CommonJS)

Source: https://microsoft.github.io/node-api-dotnet/scenarios/js-aot-module

Example of how to load a .NET Native AOT module in a JavaScript project using CommonJS syntax. It requires the published `.node` file directly from the output directory.

```javascript
const ExampleModule = require('./bin/ExampleModule');
```

--------------------------------

### C# Invalid Thread Access Example

Source: https://microsoft.github.io/node-api-dotnet/features/js-threading-async

Demonstrates how attempting to access JavaScript values from a separate .NET thread using `Thread` will result in a `JSInvalidThreadAccessException`. This highlights the importance of adhering to the JavaScript thread affinity rules.

```csharp
using Microsoft.NodeApi.JavaScript;
using System.Threading;

public class ThreadingExamples
{
    [JSExport]
    public void InvalidThreadExample()
    {
        Thread thread = new(() =>
        {
            var now = new JSDate(); // throws JSInvalidThreadAccessException
        });
        thread.Start();
        thread.Join();
    }
}
```

--------------------------------

### NodejsRuntime.node_embedding_module_initialize_callback constructor (1 of 2)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.node_embedding_module_initialize_callback/node_embedding_module_initialize_callback

Initializes a new instance of the NodejsRuntime.node_embedding_module_initialize_callback struct with a delegate callback.

```APIDOC
## NodejsRuntime.node_embedding_module_initialize_callback constructor (1 of 2)

### Description
Initializes a new instance of the NodejsRuntime.node_embedding_module_initialize_callback struct with a delegate callback.

### Method

```
public node_embedding_module_initialize_callback(Delegate callback)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "callback": "Delegate"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get JS Value Expression (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.DotNetHost/JSMarshaller/GetToJSValueExpression

Retrieves a lambda expression that converts a specified type to a JavaScript value. This method caches conversion expressions for repeated use, improving performance. It throws a NotSupportedException if the provided type cannot be converted.

```csharp
public LambdaExpression GetToJSValueExpression(Type fromType)
```

--------------------------------

### C# napi_async_complete_callback Constructor with IntPtr

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi.Runtime/NodejsRuntime.napi_async_complete_callback/napi_async_complete_callback

Initializes a new instance of the napi_async_complete_callback struct using an IntPtr. This constructor is provided by the Node API for .NET for lower-level memory management or integration with unmanaged code.

```csharp
public napi_async_complete_callback(IntPtr Handle)
```

--------------------------------

### Attach Object to JSValue and Get Weak Reference (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSValue/Wrap

This overload of the JSValue.Wrap method in C# attaches a .NET object to a JavaScript value and also provides a weak reference to the generated JavaScript wrapper. It returns the JS wrapper itself.

```csharp
public JSValue Wrap(object value, out JSReference wrapperWeakRef)
```

--------------------------------

### Managing Reference Strength (C#)

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSReference

Shows how to convert between strong and weak references using MakeStrong() and MakeWeak(). These methods allow control over whether the JS value is protected from garbage collection.

```csharp
public void MakeStrong();
```

```csharp
public void MakeWeak();
```

--------------------------------

### Get JavaScript Export Name - C#

Source: https://microsoft.github.io/node-api-dotnet/reference/dotnet/Microsoft.JavaScript.NodeApi/JSExportAttribute/Name

This C# code snippet demonstrates how to access the `Name` property of the `JSExportAttribute`. This property retrieves the name assigned to an item when it's exported to JavaScript, or null if the name is auto-generated (typically camel-cased).

```csharp
public string? Name { get; }
```
Tokens:
Raw