TypeScriptGeneratorSettings Class

Summary

Settings to further control the generation of TypeScript code
Assembly
Cake.NSwag.dll
Namespace
Cake.NSwag.Settings
Base Types
graph BT Type-->Base0["GeneratorSettings"] click Base0 "/api/Cake.NSwag.Settings/GeneratorSettings" Base0-->Base1["Object"] Type["TypeScriptGeneratorSettings"] class Type type-node

Syntax

public class TypeScriptGeneratorSettings : GeneratorSettings

Properties

Name Value Summary
ClassName string
The class name to use for generated client code
ClientSettings ClientGeneratorBaseSettings
Container for operation-specific settings used when generating client libraries.
Inherited from GeneratorSettings
ControllerSettings ControllerGeneratorBaseSettings
Container for operation-specific settings used when generating controller code.
Inherited from GeneratorSettings
JsonSettings JsonSchemaGeneratorSettings
Container for operation-specific settings used when generating JSON schemas, including Swagger specifications.
Inherited from GeneratorSettings
ModuleName string
The module name to use when generating a module

Methods

Name Value Summary
WithSettings(ClientGeneratorBaseSettings) GeneratorSettings
Specifies operation-specific settings for generating client code.
Inherited from GeneratorSettings
WithSettings(ControllerGeneratorBaseSettings) GeneratorSettings
Specificies operation-specific settings for generating controller code
Inherited from GeneratorSettings
WithSettings(JsonSchemaGeneratorSettings) GeneratorSettings
Specifies operation-specific settings for generating JSON schemas, including Swagger specifications.
Inherited from GeneratorSettings

Extension Methods

Name Value Summary
Dump<TypeScriptGeneratorSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TypeScriptGeneratorSettings>(TypeScriptGeneratorSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TypeScriptGeneratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TypeScriptGeneratorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TypeScriptGeneratorSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TypeScriptGeneratorSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
WithClassName(string) TypeScriptGeneratorSettings
Sets the class name for the genertated client
Requires the Cake.NSwag addin
WithModuleName(string) TypeScriptGeneratorSettings
Sets the module name for the generated client
Requires the Cake.NSwag addin