Doubter - v5.2.0
    Preparing search index...

    Interface ParameterizedRefineOptions<Param>

    Options of a refinement operation.

    interface ParameterizedRefineOptions<Param> {
        code?: any;
        message?:
            | null
            | string
            | number
            | bigint
            | boolean
            | symbol
            | object
            | MessageCallback;
        meta?: any;
        param: Param;
        tolerance?: OperationTolerance;
        type?: any;
    }

    Type Parameters

    • Param

      The param that is passed to a callback when an operation is applied.

    Hierarchy (View Summary)

    Index

    Properties

    code? message? meta? param tolerance? type?

    Properties

    code?: any

    The code of an issue that would be raised if the refinement fails.

    "any.refine"

    Issue.code

    message?:
        | null
        | string
        | number
        | bigint
        | boolean
        | symbol
        | object
        | MessageCallback

    The custom issue message.

    meta?: any

    An arbitrary metadata that is added to an issue.

    Issue.meta

    param: Param

    The additional param associated with the operation. Usually contains a type-specific data is used in the Operation.callback.

    Operation.param

    undefined
    tolerance?: OperationTolerance

    The operation tolerance for issues that are raised during validation.

    "skip"
    If preceding operations have raised issues, then this operation is skipped but consequent operations are still applied.
    "abort"
    If preceding operations have raised issues, then this operation is skipped and consequent operations aren't applied. Also, if this operation itself raises issues then consequent operations aren't applied either.
    "auto"
    The operation is applied regardless of previously raised issues.

    Operation.tolerance

    'auto'
    type?: any

    The type of the operation such as "string.regex" or "array.includes". If omitted then operation callback is used as its type.

    Operation.type

    Settings

    Member Visibility

    On This Page

    Properties