View Source FLHook.Event (FLHook Client v1.0.0)

An event that is sent by the client in event mode when something happens on the server.

Link to this section Summary

Functions

Fetches the param with the specified key from the params collection. Optionally allows specification of a type to coerce the param to.

Fetches the param with the specified key from the params collection. Optionally allows specification of a type to coerce the param to. Raises when the param is missing or could not be coerced to the given type.

Link to this section Types

Specs

t() :: %FLHook.Event{params: FLHook.Params.t(), type: String.t()}

Link to this section Functions

Link to this function

param(event, key, type \\ :string)

View Source

Specs

param(t(), FLHook.Params.key(), FLHook.Params.param_type()) ::
  {:ok, any()} | {:error, FLHook.ParamError.t()}

Fetches the param with the specified key from the params collection. Optionally allows specification of a type to coerce the param to.

Link to this function

param!(event, key, type \\ :string)

View Source

Specs

Fetches the param with the specified key from the params collection. Optionally allows specification of a type to coerce the param to. Raises when the param is missing or could not be coerced to the given type.