TypeScriptModelsGenerator 1.0.8
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package TypeScriptModelsGenerator --version 1.0.8
NuGet\Install-Package TypeScriptModelsGenerator -Version 1.0.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TypeScriptModelsGenerator" Version="1.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TypeScriptModelsGenerator --version 1.0.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TypeScriptModelsGenerator, 1.0.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TypeScriptModelsGenerator as a Cake Addin
#addin nuget:?package=TypeScriptModelsGenerator&version=1.0.8
// Install TypeScriptModelsGenerator as a Cake Tool
#tool nuget:?package=TypeScriptModelsGenerator&version=1.0.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Support for system types (also as nullable)
string
int
uint
bool
byte[]
long
ulong
float
short
ushort
byte
sbyte
char
DateTime
Guid
decimal
double
Support for collections (T as generic, system type, collection or custom type)
ICollection<T>
IEnumerable<T>
IList<T>
List<T>
Array
Dictionary<T1,T2>
Support for custom types
(abstract) class
interface
enum
Support for generics: in most cases it should just work.
- Known issue: circular referenced generic arguments gives StackOverFlowException
Example usage
TypeScriptModelsGeneration
.Setup(sourceAssembly, destinationDirectory)
//Scope input of all C# models with postfix Model
.MatchModels("Model$")
//or scope input of all C# models with an expression
.MatchModels(x => x.NameSpace.Contains("Models"))
//Scope input of all C# models with postfix Model and Replace 'Model' in name with empty string
.ReplaceModels("Model$", string.Empty)
//Combine MatchModels and ReplaceModels if you use the same pattern
.MatchAndReplaceModels("Model$", string.Empty)
//Scope input of all C# models in a namespace that contains 'Models'
.MatchNameSpace("Models")
//Replace part of the c# model NameSpace to avoid extra 'my-app' and 'models' folder
.ReplaceNameSpace("MyApp", string.Empty)
.ReplaceNameSpace("Models", string.Empty)
//Combine MatchNameSpace and ReplaceNameSpace if you use the same pattern
.MatchAndReplaceNameSpace("Models", string.Empty)
//Or if you want another (nested) location try for example
//.MatchAndReplaceNameSpace("Models", "Custom.MyFolder")
//by default initialization for objects and arrays is done; omit with.
.OmitInitialization()
//use an expression to match the types you want to be initialized
//.Initialization(x => myCustomTypes.Contains(x))
// Note: if you use the 'Watch' option you should check for example on FullName instead
//FileWriteMode by default is ModelChanged
//to avoid unchanged files in version control
.FileWriteMode(mode)
// Get some simple feedback on what's happening
.Logging((log) => Console.WriteLine(log))
// Generate files
.Execute();
// Watch files
// NOTE: to enable 'Watch' option use .Setup(sourceAssemblyPath, destinationDirectoryPath)
// If your assembly has exported types that depend on other assemblies (like WebApi controllers)
// make sure to add your project as a project reference
.Watch(timeout);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection (>= 2.1.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on TypeScriptModelsGenerator:
Package | Downloads |
---|---|
TypeScriptModelsGenerator.HttpServices
Convert types to TypeScript http services. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.2.1 | 5,029 | 10/27/2022 |
1.2.0 | 13,754 | 1/9/2021 |
1.1.10 | 802 | 11/8/2020 |
1.1.9 | 2,706 | 4/10/2020 |
1.1.8 | 664 | 4/2/2020 |
1.1.7 | 654 | 3/5/2020 |
1.1.6 | 881 | 1/11/2020 |
1.1.5 | 711 | 10/28/2019 |
1.1.4 | 12,610 | 7/17/2019 |
1.1.3 | 559 | 6/10/2019 |
1.1.2 | 747 | 5/22/2019 |
1.1.1 | 1,392 | 1/24/2019 |
1.1.0 | 1,054 | 1/5/2019 |
1.0.12 | 680 | 12/21/2018 |
1.0.9 | 1,136 | 10/28/2018 |
1.0.8 | 858 | 9/18/2018 |
1.0.7 | 758 | 8/31/2018 |
1.0.6 | 858 | 8/14/2018 |
1.0.4 | 1,134 | 4/17/2018 |
1.0.3 | 1,109 | 3/30/2018 |
1.0.2 | 1,230 | 3/23/2018 |
1.0.1 | 995 | 3/19/2018 |
1.0.0 | 980 | 2/3/2018 |
* Improved generics.
* Bug fix FileNotFoundException while using Watch.
* Setup generation with a list of Types.