Function getDefaults

getDefaults<
    const TSchema extends
        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
        | LooseObjectSchema<
            ObjectEntries,
            ErrorMessage<LooseObjectIssue>
            | undefined,
        >
        | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined>
        | StrictObjectSchema<
            ObjectEntries,
            ErrorMessage<StrictObjectIssue>
            | undefined,
        >
        | ObjectWithRestSchema<
            ObjectEntries,
            BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            ErrorMessage<ObjectWithRestIssue> | undefined,
        >
        | LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined>
        | StrictTupleSchema<
            TupleItems,
            ErrorMessage<StrictTupleIssue>
            | undefined,
        >
        | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined>
        | TupleWithRestSchema<
            TupleItems,
            BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            ErrorMessage<TupleWithRestIssue> | undefined,
        >,
>(
    schema: TSchema,
): InferDefaults<TSchema>
Returns the default values of the schema.

Hint: The difference to getDefault is that for object and tuple schemas this function recursively returns the default values of the subschemas instead of undefined.
Type Parameters
- const TSchema extends
      | BaseSchema<unknown, unknown, BaseIssue<unknown>>
      | LooseObjectSchema<
          ObjectEntries,
          ErrorMessage<LooseObjectIssue>
          | undefined,
      >
      | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined>
      | StrictObjectSchema<
          ObjectEntries,
          ErrorMessage<StrictObjectIssue>
          | undefined,
      >
      | ObjectWithRestSchema<
          ObjectEntries,
          BaseSchema<unknown, unknown, BaseIssue<unknown>>,
          ErrorMessage<ObjectWithRestIssue> | undefined,
      >
      | LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined>
      | StrictTupleSchema<TupleItems, ErrorMessage<StrictTupleIssue> | undefined>
      | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined>
      | TupleWithRestSchema<
          TupleItems,
          BaseSchema<unknown, unknown, BaseIssue<unknown>>,
          ErrorMessage<TupleWithRestIssue> | undefined,
      >
Parameters
- schema: TSchema
  The schema to get them from.
Returns InferDefaults<TSchema>
The default values.
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/valibot/dist/index.d.mts:224

Function getDefaults

Type Parameters

Parameters

Returns InferDefaults<TSchema>

Settings