From e128682395281881dd0fc05ae27e233d8f6a35ad Mon Sep 17 00:00:00 2001 From: Alexis Glass Date: Sun, 26 Nov 2023 00:33:56 +0100 Subject: [PATCH] Update docs --- docs/cli-usage.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/cli-usage.md b/docs/cli-usage.md index 1981a15..4a89cef 100644 --- a/docs/cli-usage.md +++ b/docs/cli-usage.md @@ -145,7 +145,7 @@ djinni \ | `--cppcli-namespace ...` | The namespace name to use for generated C++/CLI classes. | | `--cppcli-include-cpp-prefix ` | The prefix for `#include` of the main C++ header files from C++/CLI files. | -### WebAssembly/TS/JS +### WebAssembly/Typescript/Javascript | Argument | Description | |----------------------------------------|----------------------------------------------------------------------------| @@ -155,6 +155,7 @@ djinni \ | `--wasm-base-lib-include-prefix` | The path prefix to be added to djinni support library inlcude lines in generated files | | `--ts-out ` | Path to the Typescript type definitions output folder | | `--ts-module ` | Name of the module for the Typescript types. `module.ts` by default. | +| `--ts-support-files-out ` | Path for where the support files `DjinniModule.[js|ts]` should be generated. No support files are generated if the path is not specified. | ### Yaml Generation @@ -241,6 +242,15 @@ Possible values: `FooBar`, `fooBar`, `foo_bar`, `FOO_BAR`, `m_fooBar`. | `--ident-cppcli-const` | `FooBar` | | `--ident-cppcli-file` | `FooBar` | +#### Javascript / Typescript + +| Argument | Default | +|----------------------|-----------| +| `--ident-js-enum` | `FOO_BAR` | +| `--ident-js-field` | `fooBar` | +| `--ident-js-type` | `FooBar` | + + Example: The djinni idl for an enum