Variable v1Const

A parser object made with the zod library which can be used to validate or parse Character Cards using the V1 spec.

https://github.com/malfoyslastname/character-card-spec-v2/blob/main/spec_v1.md

Example

import * as Cards from 'character-card-utils'

// parsing
Cards.v1.parse(v1Card) //=> return type Cards.V1
Cards.v1.parse(v2CardWithV1FieldsBackfilled) //=> return type Cards.V1
Cards.v1.parse(incorrectlyFormattedCard) //=> throws ZodError
Cards.v1.parse(v2Card) //=> throws ZodError

// exception-free parsing
Cards.v1.safeParse(v1Card) // => return type { success: true; data: Cards.V1 }
Cards.v1.safeParse(v2CardWithV1FieldsBackfilled) //=> return type { success: true; data: Cards.V1 }
Cards.v1.safeParse(incorrectlyFormattedCard) //=> return type { success: false; error: ZodError }
Cards.v1.safeParse(v2Card) //=> return type { success: false; error: ZodError }
Copy