@spec attachable_lifecycle_stages() :: [attachable_lifecycle_stages()]

All attachable LiveView lifecycle stages by LiveGuard.

@spec before_compile_allowed(env :: map()) :: tuple()

Optional

This macro can be used with @before_compile hook.

It will add a catch-all allowed?/4 function returning true, to the end the module.

Example

defimpl LiveGuard.Allowed, for: User do
  @before_compile {LiveGuard, :before_compile_allowed}

  # some code...
end

@spec before_compile_guarded_stages(env :: map()) :: tuple()

Optional

This macro can be used with @before_compile hook.

It will add a catch-all guarded_stages/1 function returning the valid attachable LiveView lifecycle stages (:handle_params, :handle_event, :handle_info and :handle_async), to the end the module.

Example

defimpl LiveGuard.GuardedStages, for: Atom do
  @before_compile {LiveGuard, :before_compile_guarded_stages}

  # some code...
end

@spec on_mount(
  on_mount_name :: :default,
  params :: Phoenix.LiveView.unsigned_params() | :not_mounted_at_router,
  session :: map(),
  socket :: Phoenix.LiveView.Socket.t()
) :: {:cont | :halt, socket :: Phoenix.LiveView.Socket.t()}

You can find the documentation of on_mount/1 here.