Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #102

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Update README.md #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/ClientGenerator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ candid-client-generator gen ./
- `feature-nullable` - (Bool) Optional. Sets whether to use the C# nullable feature when generating the client (like `object?`). Defaults to true
- `variants-use-properties` - (Bool) Optional. If true, the generated variant classes will use properties instead of methods for data access. Defaults to false
- `keep-candid-case` - (Bool) Optional. If true, the names of properties and methods will keep the raw candid name. Otherwise they will be converted to something prettier. Defaults to false

- `use-optional-value` - (Bool) Optional. If true, opt Candid types will be represented as OptionalValue\<T\>, otherwise will just use T?. Defaults to true. NOTE: this feature is not recommended for type and performance reasons and should be considered experimental
#### Client Level:

- `name` - (Text) REQUIRED. The name of the sub-folder put the client files and the prefix to the client class name.
Expand All @@ -76,7 +76,7 @@ candid-client-generator gen ./
- `no-folders` - (Bool) OPTIONAL. If true, no sub-folders will be generated for the client. All generated files will be in a flat structure. Defaults to false. Overrides the top level `no-folders`
- `feature-nullable` - (Bool) Optional. Sets whether to use the C# nullable feature when generating the client (like `object?`). Defaults to true. Overrides the top level `feature-nullable`
- `keep-candid-case` - (Bool) Optional. If true, the names of properties and methods will keep the raw candid name. Otherwise they will be converted to something prettier. Defaults to false. Overrides the top level `keep-candid-case`

- `use-optional-value` - (Bool) Optional. If true, opt Candid types will be represented as OptionalValue\<T\>, otherwise will just use T?. Defaults to true. NOTE: this feature is not recommended for type and performance reasons and should be considered experimental
#### Type Customization:

##### All Types
Expand Down
Loading