AtsConstants

Docs / Reference / Search C# APIs / Aspire.TypeSystem / AtsConstants

AtsConstants

Docs Reference Search C# APIs Aspire.TypeSystem AtsConstants

Class static net8.0

📦 Aspire.TypeSystem v13.2.0

Constants for ATS (Aspire Type System) type IDs and capability IDs.

namespace Aspire.TypeSystem;

public static class AtsConstants
{
    // ...
}

Source

Search members of AtsConstants...

field method

36 members Clear filters

Methods14

ArrayTypeId(string)static

string

Creates an array type ID for the given element type.

DictTypeId(string, string)static

string

Creates a Dict type ID for the given key and value types.

EnumTypeId(string)static

string

Creates an enum type ID for the given enum type full name.

GetCategory(string?, bool)static

AtsTypeCategory

Gets the type category for a type ID. Note: This method cannot distinguish DTOs from Handles based on type ID alone. Use the scanner's type mapping to determine if a handle type is actually a DTO.

GetCategory(Type)static

AtsTypeCategory

Gets the type category for a CLR type.

IsArray(string?)static

bool

Checks if a type ID represents an array type.

IsDict(string?)static

bool

Checks if a type ID represents a Dict type.

IsEnum(string?)static

bool

Checks if a type ID represents an enum type.

IsHandle(string?)static

bool

Checks if a type ID represents a handle type (has Assembly/Type format).

IsList(string?)static

bool

Checks if a type ID represents a List type.

IsPrimitive(string?)static

bool

Checks if a type ID represents a primitive type.

IsPrimitiveType(Type)static

bool

Checks if a CLR type is a primitive ATS type.

IsReadOnlyDictType(Type)static

bool

Checks if a dictionary type is readonly.

ListTypeId(string)static

string

Creates a List type ID for the given element type.

View all methods

Fields22

Anystatic

string

Any type ID. Maps from .NET Object. Accepts any supported ATS type. Use when a parameter needs to accept multiple types without explicit union declaration.

ApplicationTypeIdstatic

string

Type ID for DistributedApplication.

AspireHostingAssemblystatic

string

The Aspire.Hosting assembly name.

Booleanstatic

string

Boolean type ID. Maps from .NET Boolean.

BuildCapabilitystatic

string

Capability ID for building the application.

BuilderTypeIdstatic

string

Type ID for IDistributedApplicationBuilder.

CancellationTokenstatic

string

CancellationToken type ID. Maps from .NET Threading.CancellationToken. In TypeScript, maps to AbortSignal for cancellation support.

Charstatic

string

Char type ID. Maps from .NET Char. Serializes to JSON string.

CreateBuilderCapabilitystatic

string

Capability ID for creating a builder.

DateOnlystatic

string

DateOnly type ID. Maps from .NET DateOnly. Serializes to JSON string (YYYY-MM-DD).

DateTimestatic

string

DateTime type ID. Maps from .NET DateTime. Serializes to JSON string (ISO 8601).

DateTimeOffsetstatic

string

DateTimeOffset type ID. Maps from .NET DateTimeOffset. Serializes to JSON string (ISO 8601).

EnumPrefixstatic

string

Enum type ID prefix. Maps from .NET enum types. Full format: "enum:{FullTypeName}". Serializes to JSON string (enum name).

Guidstatic

string

Guid type ID. Maps from .NET Guid. Serializes to JSON string.

Numberstatic

string

Number type ID. Maps from .NET numeric types (int, long, float, double, decimal, etc.). Serializes to JSON number.

ReferenceExpressionTypeIdstatic

string

Type ID for ReferenceExpression.

RunCapabilitystatic

string

Capability ID for running the application.

Stringstatic

string

String type ID. Maps from .NET String.

TimeOnlystatic

string

TimeOnly type ID. Maps from .NET TimeOnly. Serializes to JSON string (HH:mm:ss).

TimeSpanstatic

string

TimeSpan type ID. Maps from .NET TimeSpan. Serializes to JSON number (total milliseconds).

Uristatic

string

Uri type ID. Maps from .NET Uri. Serializes to JSON string.

Voidstatic

string

Void type ID. Represents no return value.

View all fields