Function ObjectSerializer

Builds a serializer for a plain object or view model. A serializer is a function that takes the data to render and declares the keys to render it with:

export const AddressSerializer = (address: Address) =>
  ObjectSerializer(address).attribute('city', { openapi: 'string' })
Copy

A serializer must not read its data while being built: what it declares may not depend on its data. Dream and Psychic build it without data to read its shape (the OpenAPI schema, and the null and other-variant keys of a flattened association or customAttribute that uses it), so a serializer that reads its data while being built throws when a flattened association or customAttribute that uses it is rendered. Read the data inside a customAttribute callback, which runs only when the serializer renders, not while it is built.