Getting Started

Get TypeSharp running in your project in under 2 minutes.

Requirements

• Node.js v20 or later
• TypeScript 7 or later (if using TypeScript)
• .NET 8 SDK or later
• ASP.NET Core project with C# model classes

1. Install attributes

$  dotnet add package TypeSharp.Attributes 

2. Decorate your C# models

using TypeSharp.Attributes;
        
[TypeSharp]
public class UserDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string? Email { get; set; }
    public UserRole Role { get; set; }
    public List<string> Tags { get; set; }
}

3. Install the package

Navigate to your frontend project and install TypeSharp as a dev dependency.

$  npm install -D @siyavuyachagi/typesharp 

4. Create a configuration file

In your frontend project run the following script to scaffold a typesharp.config.ts file, which you can edit to point at your C# solution or project file.

$  npx typesharp init 

import type { TypeSharpConfig } from '@siyavuyachagi/typesharp'
    
const config: TypeSharpConfig = {
    source: ['C:/Users/User/Desktop/MyApp/MyApp.sln'],
    outputPath: './app/types',
    singleOutputFile: false,
    namingConvention: 'camel',
    fileSuffix: ''
}
    
export default config

5. Generate types

Run the following command to generate types

$  npx typesharp 

6. Use the output

Import generated types directly in your project components:

import type { UserDto } from '~/app/types/userDto.ts'

const user = ref<UserDto | null>(null);