Function deepEqual

deepEqual<
    T extends
        $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
>(
    type: T,
): Type.Equal<output<T>>
zx.deepEqual
Derive a "deep equal" function from a zod schema (v4, classic).

A "deep equal" function" (see also, Equal) is similar to lodash's isEqual function, except more performant, because when the shape of the values being compared is known ahead of time, we can optimize ahead of time, and only check what's necessary.

Note that the deep equal generated by zx.deepEqual assumes that both values have already been validated. Passing unvalidated values to the function might result in undefined behavior.

See also:
- zx.deepEqual.writeable
- zx.deepEqual.classic
Type Parameters
- T extends $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
Parameters
- type: T
Returns Type.Equal<output<T>>
Example
```
import { z } from 'zod'
import { zx } from '@traversable/zod'

const Address = z.object({
  street1: z.string(),
  street2: z.optional(z.string()),
  city: z.string(),
})

const addressEquals = zx.deepEqual(Address)

addressEquals(
  { street1: '221B Baker St', city: 'London' },
  { street1: '221B Baker St', city: 'London' }
) // => true

addressEquals(
  { street1: '221B Baker St', city: 'London' },
  { street1: '4 Privet Dr', city: 'Little Whinging' }
) // => false
```
- Defined in packages/zod/src/deep-equal.ts:737