Beignet API reference
    Preparing search index...

    Interface ValueObjectDef<Name, Schema>

    Value object definition returned by defineValueObject(...).build().

    interface ValueObjectDef<Name extends string, Schema extends StandardSchema> {
        name: Name;
        schema: Schema;
        Type: InferOutput<Schema>;
        create(input: unknown): Promise<InferOutput<Schema>>;
        isValid(input: unknown): Promise<boolean>;
    }

    Type Parameters

    • Name extends string
    • Schema extends StandardSchema
    Index

    Properties

    name schema Type

    Methods

    create isValid

    Properties

    name: Name

    Name used for debugging and introspection.

    schema: Schema

    Standard Schema used to validate values.

    Type: InferOutput<Schema>

    Type-only alias for the inferred TypeScript type. Undefined at runtime.

    Methods

    • Create a validated value from unknown input.

      This is async because Standard Schema validators may be async.

      Parameters

      • input: unknown

      Returns Promise<InferOutput<Schema>>

    • Check whether an input is valid for this value object.

      Parameters

      • input: unknown

      Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods