Update docs (#173)

microsoft · Nov 10, 2023 · 8a26082 · 8a26082
1 parent 97acf74
commit 8a26082
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 41 deletions.
diff --git a/Docs/node-module.md b/Docs/node-module.md
@@ -3,7 +3,7 @@
 For a minimal example of this scenario, see
 [../examples/dotnet-module/](../examples/dotnet-module/).
 
-1. Create a .NET Class library project that targets .NET 6 or later.
+1. Create a .NET Class library project that targets .NET 6 or later. (.NET 8 for AOT.)
     ```
     mkdir ExampleModule
     cd ExampleModule
@@ -20,13 +20,11 @@ For a minimal example of this scenario, see
     [build them from source](../README-DEV.md).<br>Then add the `out/pkg` directory as a local
     package source in your `NuGet.config`.
 
-    **Important**: Edit the project file so that both package reference elements include `PrivateAssets="all"`, and the generator reference includes `OutputItemType="Analyzer" ReferenceOutputAssembly="false"`:
+    Afterward you should have the two references in your project file:
     ```xml
     <ItemGroup>
-      <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.2.*-*"
-        PrivateAssets="all" />
-      <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.2.*-*"
-        PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+      <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" />
+      <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.4.*-*" />
     </ItemGroup>
     ```
 

diff --git a/Docs/presentation2.html b/Docs/presentation2.html
diff --git a/Docs/presentation2.md b/Docs/presentation2.md
@@ -183,6 +183,21 @@ new JSFunction("greeter", (JSValue person) =>
  - JS class can extend a .NET class, TS can implement a .NET interface
  - .NET class can implement a TS interface
 
+---
+## Generics
+The JavaScript runtime lacks generics support;
+  TypeScript generics are compile-time only!
+
+.NET generic types and methods are projected to JS via special `$` functions that accept type args:
+```JavaScript
+System.Enum.Parse$(System.DayOfWeek)('Tuesday'); // Call generic method
+System.Comparer$(System.DateTime).Create();      // Call static method on generic class
+const TaskCompletionSourceOfDate = System.TaskCompletionSource$(System.DateTime);
+new TaskCompletionSourceOfDate();                // Create instance of generic class
+```
+
+... except for generic collections, which are projected using TS generics: `IDictionary<string, int>` -> `Map<string, number>`
+
 ---
 ## .NET Native AOT
  - AOT C# code uses .NET hosting APIs to load .NET in-proc.

diff --git a/README.md b/README.md
@@ -10,8 +10,8 @@ Interop is high-performance and supports TypeScript type-definitions generation,
 it is compatible with any Node.js version (without recompiling) or other JavaScript runtime that
 supports Node API.
 
-:warning: _**Status: In Development** - Core functionality works, but many things are incomplete,
-and it isn't yet all packaged up nicely in a way that can be easily consumed._
+:warning: _**Status: Public Preview** - Most functionality works well, though there are some known
+limitations around the edges, and there may still be minor breaking API changes._
 
 [Instructions for getting started are below.](#getting-started)
 

diff --git a/examples/aot-module/aot-module.csproj b/examples/aot-module/aot-module.csproj
@@ -9,7 +9,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" PrivateAssets="none" />
+    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" />
     <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.4.*-*" />
   </ItemGroup>
 

diff --git a/examples/aot-npm-package/lib/aot-npm-package.csproj b/examples/aot-npm-package/lib/aot-npm-package.csproj
@@ -20,7 +20,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" PrivateAssets="none" />
+    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" />
     <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.4.*-*" />
   </ItemGroup>
 

diff --git a/examples/dotnet-module/dotnet-module.csproj b/examples/dotnet-module/dotnet-module.csproj
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" />
     <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.4.*-*" />
   </ItemGroup>