SushiScriptCore 1.2.0

-# Sushi Library for converting .NET classes to script language classes.

Currently supports

• TypeScript
• ECMAScript 5
• ECMAScript 6

Author

Jeroen Vorsselman @ 2023

GitHub

NuGet

Features

• Converts .NET classes to script languages (typescript / ECMAScript)
• Compiled using .NET Standard 2.0
• Supports native types, type inheritance, generics and enum types
• Adds documentation using the generated MS build XML file
• 95% Code coverage

About

string xmlDocPath =  Path.Combine(Environment.CurrentDirectory, "Sushi.tests.xml");

// Specify the types to convert using a Type[] or Assembly.ExportedTypes.
Assembly assembly = typeof(PersonViewModel).Assembly;
SushiConverter converter = new SushiConverter(assembly).UseDocumentation(xmlDocPath);

// Specify the script language and convert by invoking ToString().
ConverterOptions options = new ConverterOptions(excludeComments: true);
string result = converter.TypeScript(options).ToString();

Create a new SushiConverter instance with the given Assembly or Type[] that contain the types you want to convert. <br /> These classes must be decorated with the ConvertToScriptAttribute or inherit the IScriptModel interface. Classes can be excluded using the IgnoreForScriptAttribute. The converter contains a collection of type- and enum-descriptors. These are used to generate script models. <br />

Helpers

You can check if a type exists using: IsSushiType(IConvertModels converter, Type type, out Type resolvedType) : boolean <br /> You can convert types using: TypeScriptConverter.ResolveScriptType(Type type, string prefix = "") : string <br /> You can get the script default value using: TypeScriptConverter.ResolveDefaultValue(IPropertyDescriptor prop) : string <br />

Typescript result

/**
 * Simple model to verify complex types.
 * @extends ViewModel 
 */
export class TypeModel extends ViewModel {
    /** A nullable boolean. */
    nullableBool: boolean | null = null;
    /** A nullable string, defaults to null. */
    nullableString!: string;
    /** A DateTime instance. */
    date: Date | string | null = null;
    student: StudentViewModel = new StudentViewModel();
    students: Array<StudentViewModel> = [];
    studentPerClass: { [key: string]: Array<StudentViewModel> } = {};
    /** A readonly string. */
    readonlyString!: string;

    constructor(value: object | null = null) {
        super(value);

        if (value?.hasOwnProperty('nullableBool'))
            this.nullableBool = value['nullableBool'];

        if (value?.hasOwnProperty('nullableString'))
            this.nullableString = value['nullableString'];

        if (value?.hasOwnProperty('guid'))
            this.guid = value['guid'];

        if (value?.hasOwnProperty('date'))
            this.date = value['date'];

        if (value?.hasOwnProperty('student'))
            this.student = value['student'];

        if (value?.hasOwnProperty('students'))
            this.students = value['students'];

        if (value?.hasOwnProperty('studentPerClass'))
            this.studentPerClass = value['studentPerClass'];

        if (value?.hasOwnProperty('createdOn'))
            this.createdOn = value['createdOn'];

        if (value?.hasOwnProperty('readonlyString'))
            this.readonlyString = value['readonlyString'];

    }
}