SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ValueOptions

    Passed to various methods to control coercion behavior when getting or iterating values.

    interface ValueOptions {
        coerce?: CoerceParams;
        errorOnInvalidCoercion?: boolean;
        onError?: "value" | "throw" | "ignore" | ((error: Known) => void);
        type?: ScalarType | null;
    }

    Hierarchy (View Summary)

    Index
    coerce? errorOnInvalidCoercion? onError? type?
    coerce?: CoerceParams

    Overrides default coercion behavior per type. When a value cannot be coerced, onError determines the fallback.

    errorOnInvalidCoercion?: boolean

    If true, coercion failure produces #VALUE! rather than silently skipping the value.

    false

    onError?: "value" | "throw" | "ignore" | ((error: Known) => void)

    What to do when the visited value is a FormulaError.

    throw

    'throw' = throw error. 'ignore' = silently skip the value. 'value' = return a specific error value (default #VALUE!). 'function' = custom handler; use this to return a specific error value.

    type?: ScalarType | null

    Specifies the target type for coercion and filtering when getting or iterating values.

    The scalar type of the IRange itself (getType())

    • Values matching the type pass through unchanged.
    • Values coercible to the type are coerced.
    • If not set, the range's own scalar type (getType()) is used.
    • If the range has no scalar type, or set to null explicitly, no coercion or filtering is performed.

    Settings
    Member Visibility

    On This Page
    Properties