Skip to content

Commit 2e356fe

Browse files
authored
doc - Update README.md
1 parent 8097a85 commit 2e356fe

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ The Wasm interop project can be found in the [canhorn/EventHorizon.Blazor.Intero
2929
* [NodeJS](https://nodejs.org/)
3030
* Required Version >= 20
3131

32+
## Using the Tool
33+
34+
~~~ bash
35+
dotnet tool install -g EventHorizon.Blazor.TypeScript.Interop.Tool
36+
~~~
37+
38+
## Command Line Options
39+
40+
Identifier | Details | Required/Default
41+
--- | --- | ---
42+
-s, --source <source> | TypeScript Definition to generate from, can be a File or URL, accepts multiple or as Array | REQUIRED
43+
-c, --class-to-generate <class-to-generate> | A Class to generate, accepts multiple or as Array | REQUIRED
44+
-a, --project-assembly <project-assembly> | The project name of the Assembly that will be generated | Default: "Generated.WASM"
45+
-l, --project-generation-location <project-generation-location> | The directory where the Generated Project assembly will be saved | Default: "_generated"
46+
-f, --force | This will force generation, by deleting --project-generation-location | Default: (False)
47+
-p, --parser | The type of TypeScript parser to use, Supported values: ("dotnet","nodejs") | Default: ("dotnet")
48+
-h, --host-type | The host type the source should be generator for, Supported values: ("wasm","server"). | Default: ("wasm")
49+
50+
More details in the [Tool README.md](./Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/README.md).
51+
3252
## TypeScript Parser
3353

3454
The generation relies heavily on the TypeScript Abstract Syntax Tree and so the code includes ways to parse the source files into a AST representation for easier generation.

0 commit comments

Comments
 (0)