Either

A type that can hold a value of either type T1 or type T2.

Either is useful for function parameters that can accept multiple types while still providing compile-time type hints. At runtime, the value is still Dynamic, so type checking may be necessary.

Important Notes #

• This does NOT make Dynamic usage type-safe
• Runtime type checks with Std.isOfType() are still necessary
• The underlying type is Dynamic, so runtime errors are possible
• Best used for API clarity rather than type safety

Usage Examples #

// Function accepting String or Int
function processValue(value:Either<String, Int>) {
    if (Std.isOfType(value, String)) {
        trace("String: " + cast(value, String));
    } else if (Std.isOfType(value, Int)) {
        trace("Int: " + cast(value, Int));
    }
}

processValue("hello");  // Works
processValue(42);       // Works
// processValue(true);  // Compile error

// Common pattern with asset loading
function loadAsset(id:Either<String, AssetId<String>>):String {
    if (Std.isOfType(id, AssetId)) {
        return cast(id, AssetId<String>).toString();
    }
    return cast id;
}

Type Parameters #

Type Conversions #

From:

• [ceramic.Either.T1](/api-docs/clay-native/ceramic/Either/T1/)

To:

• [ceramic.Either.T1](/api-docs/clay-native/ceramic/Either/T1/)