objectWithRest

Creates an object with rest schema.

const Schema = v.objectWithRest<TEntries, TRest, TMessage>(
  entries,
  rest,
  message
);

Generics

• TEntries extends ObjectEntries
• TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<ObjectWithRestIssue> | undefined

Parameters

• entries TEntries
• rest TRest
• message TMessage

Explanation

With objectWithRest you can validate the data type of the input and whether the content matches entries and rest. If the input is not an object, you can use message to customize the error message.

The difference to object is that this schema includes unknown entries in the output. In addition, this schema filters certain entries from the unknown entries for security reasons.

Returns

• Schema ObjectWithRestSchema<TEntries, TRest, TMessage>

Examples

The following examples show how objectWithRest can be used. Please see the object guide for more examples and explanations.

Object schema with rest

Schema to validate an object with generic rest entries.

const ObjectSchemaWithRest = v.objectWithRest(
  {
    key1: v.string(),
    key2: v.number(),
  },
  v.boolean()
);

Merge several objects

Schema that merges the entries of two object schemas.

const MergedObjectSchema = v.objectWithRest(
  {
    ...ObjectSchema1.entries,
    ...ObjectSchema2.entries,
  },
  v.null()
);

Mark keys as optional

Schema to validate an object with partial entries.

const PartialObjectSchema = partial(
  objectWithRest(
    {
      key1: string(),
      key2: number(),
    },
    v.undefined()
  )
);

Object with selected entries

Schema to validate only selected entries of an object.

const PickObjectSchema = v.pick(
  v.objectWithRest(
    {
      key1: v.string(),
      key2: v.number(),
      key3: v.boolean(),
    },
    v.null()
  ),
  ['key1', 'key3']
);

Related

The following APIs can be combined with objectWithRest.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• exactOptional,
• file,
• function,
• instance,
• intersect,
• lazy,
• literal,
• looseObject,
• looseTuple,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• promise,
• record,
• set,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• undefinedable,
• union,
• unknown,
• variant,
• void

Methods

• assert,
• config,
• fallback,
• forward,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• keyof,
• message,
• omit,
• parse,
• parser,
• partial,
• pick,
• pipe,
• required,
• safeParse,
• safeParser

Actions

• check,
• brand,
• description,
• maxEntries,
• metadata,
• minEntries,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• title,
• transform

Utils

• entriesFromList,
• isOfKind,
• isOfType