IwoHerka
Should I provide typespec for each function clause?
When creating multiple clauses for a function, should I provide typespec for each one? Example:
@spec foo([]) :: {:error, any}
def foo([]) do
...
{:error, ...}
end
@spec foo([integer]) :: {:ok, any}
def foo(some_list) do
...
{:ok, ...}
end
…or is something like this preferrable?
@spec foo([integer]) :: {:ok, any} | {:error, any}
def foo([]) do
...
{:error, ...}
end
def foo(some_list) do
...
{:ok, ...}
end
Thanks!
Most Liked
rvirding
You are defining ONE function so it should be for that function which you give the typespec.
sbuttgereit
I’ll typically use the second approach.
The different function heads which ultimately need to be defined by the spec are typically grouped together and having a spec at the top of that group makes for a reasonable signpost in the source code for the beginning of that group.
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Real-time error tracking, performance insights, and observability for devs.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Real-time error tracking, performance insights, and observability for devs.
Practical resources that improve the lives of professional developers.
Producing high quality Elixir screencasts since 2017.
Enabling companies to succeed by building software people love.
Courses that'll move you from confusion to "Aha, now I get it!"