vforteli.TypeScriptModelGenerator 0.1.0

.NET 8.0

dotnet add package vforteli.TypeScriptModelGenerator --version 0.1.0

NuGet\Install-Package vforteli.TypeScriptModelGenerator -Version 0.1.0

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="vforteli.TypeScriptModelGenerator" Version="0.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add vforteli.TypeScriptModelGenerator --version 0.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: vforteli.TypeScriptModelGenerator, 0.1.0"

#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 vforteli.TypeScriptModelGenerator as a Cake Addin
#addin nuget:?package=vforteli.TypeScriptModelGenerator&version=0.1.0

// Install vforteli.TypeScriptModelGenerator as a Cake Tool
#tool nuget:?package=vforteli.TypeScriptModelGenerator&version=0.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TypeScriptModelGenerator

Generate TypeScript types from dotnet models. This thing probably wont work with all possible types, but for now covers most use cases.

Usage

// From a type
var types = new Dictionary<string, string>();
var typeName = TypeScriptModelGenerator.ParseTypeRecursively(typeof(SomeType), types, false);

// From method parameters using ParameterInfo
var types = new Dictionary<string, string>();
var type = TypeScriptModelGenerator.ParseParameterInfo(someParameterInfo, types);

// types will contain a dictionary of all the recognized TypeScript type names and their respective definition

See tests for more examples of output

Note that it is not possible to determine if a generic parameter is nullable through reflection. Therefore cases such as Task<SomeReferenceType?> cannot be detected.

Nullability of reference types can be determined when used in method parameters or properties.

todo

consider namespaces when processing types
more types

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.1.0	95	11/20/2024