Placid.Response.StatusCode

Helper data for dealing with HTTP status codes.

Remember the name of a status code but need the numeric code for your endpoint? Or maybe you’re getting a response back from a third-party and want to translate that 418 to a human-readable for for your end-users?

You’ve come to the right place.

Summary

find(status)

Translates a given integer or atom into a status code

Types

t :: %Placid.Response.StatusCode{code: 100 .. 999, reason: binary}

Functions

find(status)

Specs:

Translates a given integer or atom into a status code.

Returns 200 OK for unknown entities.

Arguments

  • status - Integer | Atom

Returns

Placid.Response.StatusCode

Examples

iex> Placid.Response.StatusCode.find 200
%Placid.Response.StatusCode{code: 200, reason: "OK"}

iex> Placid.Response.StatusCode.find :forbidden
%Placid.Response.StatusCode{code: 403, reason: "Forbidden"}

iex> Placid.Response.StatusCode.find 418
%Placid.Response.StatusCode{code: 418, reason: "I'm a teapot"}

iex> Placid.Response.StatusCode.find nil
%Placid.Response.StatusCode{code: 200, reason: "OK"}