Question 1

How does TypedStruct handle fields that can be nil?

Accepted Answer

It automatically makes types nullable for fields without enforce: true or default values, as explained in the README's transformation examples. For instance, a field with no options gets String.t() | nil in the generated type.

Question 2

Can I use TypedStruct with Ecto schemas?

Accepted Answer

Not directly; TypedStruct is for plain Elixir structs, while Ecto schemas require different definitions. The README mentions TypedEctoSchema as a related library for Ecto integration, but TypedStruct itself doesn't support Ecto out of the box.

Question 3

TypedStruct vs Domo: which should I choose?

Accepted Answer

TypedStruct focuses on reducing boilerplate in type definitions, while Domo validates structs at runtime. Use TypedStruct if you want concise type generation; pair it with Domo or similar if you need runtime validation, as noted in the README's related libraries section.

Question 4

How to generate lenses with TypedStruct?

Accepted Answer

Install the typed_struct_lens plugin, add plugin TypedStructLens in the typedstruct block, and it will generate lens functions for each field, as shown in the README example for integration with the Lens library.

Question 5

Does TypedStruct work in production without runtime issues?

Accepted Answer

Yes, it's designed for compile-time use and can be added with runtime: false in Mix dependencies. However, since it only generates types, runtime errors from type mismatches aren't caught unless you use additional validation tools.

Question 6

What happens if I forget to specify a field type?

Accepted Answer

The field macro requires a type argument; if omitted, it will cause a compile error, ensuring that all fields are typed. This is enforced by the DSL's syntax, preventing incomplete definitions.

typed_struct

What is typed_struct?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions