Base

GitHub

Base class for error serializers.

Error serializers handle serialization of errors and define error-related types at the API level.

Example

class MyErrorSerializer < Serializer::Error::Base
  api_builder Builder::API

  def serialize(error, context:)
    { errors: error.issues.map(&:to_h) }
  end
end

Class Methods

.api_builder

.api_builder(klass = nil)

GitHub

The API builder for this serializer.

Parameters

Name	Type	Default	Description
klass	Class<Builder::API::Base>, nil	nil	The builder class.

Returns

Class<Builder::API::Base>, nil

---

.data_type

.data_type(name = nil)

GitHub

The data type for this serializer.

Parameters

Name	Type	Default	Description
name	Symbol, nil	nil	The type name.

Returns

Symbol, nil

---

Instance Methods

#serialize

#serialize(error, context:)

GitHub

Serializes an error.

Parameters

Name	Type	Default	Description
error	Error		The error to serialize.
context	Hash		The serialization context.

Returns

Hash

---