FuncType - v0.9.5
    Preparing search index...

    Interface ValidatedBrandCompanion<K, T>

    interface ValidatedBrandCompanion<K extends string, T> {
        brand: K;
        from: (value: T) => Either<string, ValidatedBrand<K, T>>;
        is: (value: unknown) => value is ValidatedBrand<K, T>;
        of: (value: T) => Option<ValidatedBrand<K, T>>;
        refine: <K2 extends string>(
            brand: K2,
            validate: (value: Brand<K, T>) => boolean,
        ) => ValidatedBrandCompanion<K2, Brand<K, T>>;
        unsafeOf: (value: T) => ValidatedBrand<K, T>;
        unwrap: (branded: Brand<K, T>) => T;
        validate: (value: T) => boolean;
    }

    Type Parameters

    • K extends string
    • T
    Index

    Properties

    brand: K
    from: (value: T) => Either<string, ValidatedBrand<K, T>>
    is: (value: unknown) => value is ValidatedBrand<K, T>
    of: (value: T) => Option<ValidatedBrand<K, T>>
    refine: <K2 extends string>(
        brand: K2,
        validate: (value: Brand<K, T>) => boolean,
    ) => ValidatedBrandCompanion<K2, Brand<K, T>>
    unsafeOf: (value: T) => ValidatedBrand<K, T>
    unwrap: (branded: Brand<K, T>) => T
    validate: (value: T) => boolean