Skip to main content

TypeScriptGenerator

Assembly: ServiceStack.dll
View Source
Declaration
public class TypeScriptGenerator : ILangGenerator

Properties

AllTypes

View Source
Declaration
public List<MetadataType> AllTypes { get; set; }

UseUnionTypeEnums

View Source
Declaration
public static bool UseUnionTypeEnums { get; set; }

EmitPartialConstructors

View Source
Declaration
public static bool EmitPartialConstructors { get; set; }

PreTypeFilter

View Source
Declaration
public static Action<StringBuilderWrapper, MetadataType> PreTypeFilter { get; set; }

InnerTypeFilter

View Source
Declaration
public static Action<StringBuilderWrapper, MetadataType> InnerTypeFilter { get; set; }

PostTypeFilter

View Source
Declaration
public static Action<StringBuilderWrapper, MetadataType> PostTypeFilter { get; set; }

PrePropertyFilter

View Source
Declaration
public static Action<StringBuilderWrapper, MetadataPropertyType, MetadataType> PrePropertyFilter { get; set; }

PostPropertyFilter

View Source
Declaration
public static Action<StringBuilderWrapper, MetadataPropertyType, MetadataType> PostPropertyFilter { get; set; }

TypeFilter

View Source
Declaration
public static TypeFilterDelegate TypeFilter { get; set; }

CookedTypeFilter

View Source
Declaration
public static Func<string, string> CookedTypeFilter { get; set; }

DeclarationTypeFilter

View Source
Declaration
public static TypeFilterDelegate DeclarationTypeFilter { get; set; }

CookedDeclarationTypeFilter

View Source
Declaration
public static Func<string, string> CookedDeclarationTypeFilter { get; set; }

ReturnMarkerFilter

View Source
Declaration
public static Func<string, string> ReturnMarkerFilter { get; set; }

FilterTypes

View Source
Declaration
public static Func<List<MetadataType>, List<MetadataType>> FilterTypes { get; set; }

InsertTsNoCheck

View Source
Declaration
public static bool InsertTsNoCheck { get; set; }

InsertCodeFilter

Add Code to top of generated code

View Source
Declaration
public static AddCodeDelegate InsertCodeFilter { get; set; }

AddCodeFilter

Add Code to bottom of generated code

View Source
Declaration
public static AddCodeDelegate AddCodeFilter { get; set; }

AddQueryParamOptions

Include Additional QueryString Params in Header Options

View Source
Declaration
public List<string> AddQueryParamOptions { get; set; }

WithoutOptions

Emit code without Header Options

View Source
Declaration
public bool WithoutOptions { get; set; }

DictionaryDeclaration

View Source
Declaration
public string DictionaryDeclaration { get; set; }

AddedDeclarations

View Source
Declaration
public HashSet<string> AddedDeclarations { get; set; }

PropertyTypeFilter

View Source
Declaration
public static Func<TypeScriptGenerator, MetadataType, MetadataPropertyType, string> PropertyTypeFilter { get; set; }

IsPropertyOptional

Whether property should be marked optional

View Source
Declaration
public static Func<TypeScriptGenerator, MetadataType, MetadataPropertyType, bool?> IsPropertyOptional { get; set; }

UseNullableProperties

Helper to make Nullable properties

View Source
Declaration
public static bool UseNullableProperties { set; }

Fields

Config

View Source
Declaration
public readonly MetadataTypesConfig Config

DefaultImports

View Source
Declaration
public static List<string> DefaultImports

TypeAliases

View Source
Declaration
public static Dictionary<string, string> TypeAliases

ReturnTypeAliases

View Source
Declaration
public static Dictionary<string, string> ReturnTypeAliases

ArrayTypes

View Source
Declaration
public static HashSet<string> ArrayTypes

DictionaryTypes

View Source
Declaration
public static HashSet<string> DictionaryTypes

AllowedKeyTypes

View Source
Declaration
public static HashSet<string> AllowedKeyTypes

Methods

DefaultFilterTypes(List<MetadataType>)

View Source
Declaration
public static List<MetadataType> DefaultFilterTypes(List<MetadataType> types)
Returns

System.Collections.Generic.List<ServiceStack.MetadataType>

Parameters
TypeName
System.Collections.Generic.List<ServiceStack.MetadataType>types

GetCode(MetadataTypes, IRequest, INativeTypesMetadata)

View Source
Declaration
public string GetCode(MetadataTypes metadata, IRequest request, INativeTypesMetadata nativeTypes)
Returns

System.String

Parameters
TypeName
ServiceStack.MetadataTypesmetadata
ServiceStack.Web.IRequestrequest
ServiceStack.NativeTypes.INativeTypesMetadatanativeTypes

GetPropertyType(MetadataPropertyType, out Boolean)

View Source
Declaration
public virtual string GetPropertyType(MetadataPropertyType prop, out bool isNullable)
Returns

System.String

Parameters
TypeName
ServiceStack.MetadataPropertyTypeprop
System.BooleanisNullable

AddProperties(StringBuilderWrapper, MetadataType, Boolean)

View Source
Declaration
public void AddProperties(StringBuilderWrapper sb, MetadataType type, bool includeResponseStatus)
Parameters
TypeName
ServiceStack.NativeTypes.StringBuilderWrappersb
ServiceStack.MetadataTypetype
System.BooleanincludeResponseStatus

DefaultIsPropertyOptional(TypeScriptGenerator, MetadataType, MetadataPropertyType)

View Source
Declaration
public static bool? DefaultIsPropertyOptional(TypeScriptGenerator generator, MetadataType type, MetadataPropertyType prop)
Returns

System.Nullable<System.Boolean>

Parameters
TypeName
ServiceStack.NativeTypes.TypeScript.TypeScriptGeneratorgenerator
ServiceStack.MetadataTypetype
ServiceStack.MetadataPropertyTypeprop

AppendAttributes(StringBuilderWrapper, List<MetadataAttribute>)

View Source
Declaration
public bool AppendAttributes(StringBuilderWrapper sb, List<MetadataAttribute> attributes)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.NativeTypes.StringBuilderWrappersb
System.Collections.Generic.List<ServiceStack.MetadataAttribute>attributes

TypeValue(String, String)

View Source
Declaration
public string TypeValue(string type, string value)
Returns

System.String

Parameters
TypeName
System.Stringtype
System.Stringvalue

Type(MetadataTypeName)

View Source
Declaration
public string Type(MetadataTypeName typeName)
Returns

System.String

Parameters
TypeName
ServiceStack.MetadataTypeNametypeName

DeclarationType(String, String[], out String)

View Source
Declaration
public string DeclarationType(string type, string[] genericArgs, out string addDeclaration)
Returns

System.String

Parameters
TypeName
System.Stringtype
System.String[]genericArgs
System.StringaddDeclaration

Type(String, String[])

View Source
Declaration
public string Type(string type, string[] genericArgs)
Returns

System.String

Parameters
TypeName
System.Stringtype
System.String[]genericArgs

NameOnly(String)

View Source
Declaration
public string NameOnly(string type)
Returns

System.String

Parameters
TypeName
System.Stringtype

AppendComments(StringBuilderWrapper, String)

View Source
Declaration
public bool AppendComments(StringBuilderWrapper sb, string desc)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.NativeTypes.StringBuilderWrappersb
System.Stringdesc

AppendDataContract(StringBuilderWrapper, MetadataDataContract)

View Source
Declaration
public void AppendDataContract(StringBuilderWrapper sb, MetadataDataContract dcMeta)
Parameters
TypeName
ServiceStack.NativeTypes.StringBuilderWrappersb
ServiceStack.MetadataDataContractdcMeta

AppendDataMember(StringBuilderWrapper, MetadataDataMember, Int32)

View Source
Declaration
public bool AppendDataMember(StringBuilderWrapper sb, MetadataDataMember dmMeta, int dataMemberIndex)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.NativeTypes.StringBuilderWrappersb
ServiceStack.MetadataDataMemberdmMeta
System.Int32dataMemberIndex

GenericArg(String)

View Source
Declaration
public string GenericArg(string arg)
Returns

System.String

Parameters
TypeName
System.Stringarg

ConvertFromCSharp(TextNode)

View Source
Declaration
public string ConvertFromCSharp(TextNode node)
Returns

System.String

Parameters
TypeName
ServiceStack.TextNodenode

GetPropertyName(String)

View Source
Declaration
public string GetPropertyName(string name)
Returns

System.String

Parameters
TypeName
System.Stringname

GetPropertyName(MetadataPropertyType)

View Source
Declaration
public string GetPropertyName(MetadataPropertyType prop)
Returns

System.String

Parameters
TypeName
ServiceStack.MetadataPropertyTypeprop

Implements