TorutekGithub.SigSpec.CodeGeneration.CSharp
0.3.1
dotnet add package TorutekGithub.SigSpec.CodeGeneration.CSharp --version 0.3.1
NuGet\Install-Package TorutekGithub.SigSpec.CodeGeneration.CSharp -Version 0.3.1
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="TorutekGithub.SigSpec.CodeGeneration.CSharp" Version="0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TorutekGithub.SigSpec.CodeGeneration.CSharp" Version="0.3.1" />
<PackageReference Include="TorutekGithub.SigSpec.CodeGeneration.CSharp" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TorutekGithub.SigSpec.CodeGeneration.CSharp --version 0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TorutekGithub.SigSpec.CodeGeneration.CSharp, 0.3.1"
#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.
#:package TorutekGithub.SigSpec.CodeGeneration.CSharp@0.3.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TorutekGithub.SigSpec.CodeGeneration.CSharp&version=0.3.1
#tool nuget:?package=TorutekGithub.SigSpec.CodeGeneration.CSharp&version=0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
SigSpec for SignalR Core
Code generator for SignalR Core.
Based on NJsonSchema (see also: NSwag).
Usage
Generate CSharp Client
var sigSpecSettings = new SigSpecGeneratorSettings();
var generator = new SigSpecGenerator(sigSpecSettings);
var document = await generator.GenerateForHubsAsync(new Dictionary<string, Type>
{
{ "my-hub", typeof(MyHub) }
});
var codeGeneratorSettings = new SigSpecToCSharpGeneratorSettings
{
CSharpGeneratorSettings =
{
Namespace = "MyProject.SignalR.Clients",
GenerateNullableReferenceTypes = true,
}
};
var codeGenerator = new SigSpecToCSharpGenerator(codeGeneratorSettings);
var code = codeGenerator.GenerateClients(document);
File.WriteAllText("SignalRClient.cs", code);
Generate TypeScript Client
var sigSpecSettings = new SigSpecGeneratorSettings();
var generator = new SigSpecGenerator(sigSpecSettings);
var document = await generator.GenerateForHubsAsync(new Dictionary<string, Type>
{
{ "my-hub", typeof(MyHub) }
});
var codeGeneratorSettings = new SigSpecToTypeScriptGeneratorSettings
{
TypeScriptGeneratorSettings =
{
TypeStyle = TypeScriptTypeStyle.Class,
NullValue = TypeScriptNullValue.Null,
MarkOptionalProperties = false,
ConvertConstructorInterfaceData = true
}
};
var codeGenerator = new SigSpecToTypeScriptGenerator(codeGeneratorSettings);
var code = string.Join(Environment.NewLine,
"/* tslint:disable */",
"/* eslint-disable */",
"// @ts-ignore",
codeGenerator.GenerateFile(document)
);
File.WriteAllText("SignalRClient.ts", code);
| Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- NJsonSchema.CodeGeneration (>= 11.1.0)
- NJsonSchema.CodeGeneration.CSharp (>= 11.1.0)
- TorutekGithub.SigSpec.CodeGeneration (>= 0.3.1)
- TorutekGithub.SigSpec.Core (>= 0.3.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.