Function●Since v1.0

getSchemaDescription

Retrieves the description from a schema definition (v3, v4, or plain object), if available.

getSchemaDescription(
  schema: Record<string, unknown> | InteropZodType<unknown, unknown>
): string | undefined

Parameters

Name	Type	Description
`schema`*	`Record<string, unknown> \| InteropZodType<unknown, unknown>`	The schema to extract the description from.