EntriesSpec

A specification for a set of entries.

Type Parameters

• E extends EntriesSchema

readonly schema: E

The schema for this set of entries. This is public so that it can be used to create new schemas, but the object is frozen and so cannot be mutated.

parse(input, options, path): EntriesOutputType<E>

As safeParse but will throw an exception if errors are encountered.

• options: EntriesParseOptions<E> = DEFAULT_ENTRIES_PARSE_OPTIONS

• path: string[] = []

safeParse(input, options, path): ParseResult<EntriesOutputType<E>>

Parse entries without throwing an exception.

A record of string keys to PODValues, strings, bigints or numbers.

• options: EntriesParseOptions<E> = DEFAULT_ENTRIES_PARSE_OPTIONS

Options controlling how parsing of entries is performed.

• path: string[] = []

The path leading to this object.

ParseResult<EntriesOutputType<E>>

A ParseResult containing either a valid result or list of issues.

static create<E>(schema): EntriesSpec<E>

Creates an EntriesSpec object from a given schema.

• E extends Readonly<Record<string, EntrySchema>>

• schema: E

The schema to use for this set of entries.

A new EntriesSpec object