exvalidate v0.0.1 Exvalidate.PlugError View Source

Define the error functions for the plug. We can choose return errors in the next formats:

Json: using the json_error function.
Plain Text: using the plain_error function.

If you want create a custom error function, you can define this function in a module and then call the plug validate:

plug(PlugValidate, on_error: &PlugError.json_error/2)

You set the "on_error" param with the your custom function.

Link to this section Summary

Functions

json_error(conn, error_message)

return the error in json format.

plain_error(conn, error_message)

return the error in text plain format.

Link to this section Functions

json_error(conn, error_message)

json_error(
  %Plug.Conn{
    adapter: term(),
    assigns: term(),
    before_send: term(),
    body_params: term(),
    cookies: term(),
    halted: term(),
    host: term(),
    method: term(),
    owner: term(),
    params: term(),
    path_info: term(),
    path_params: term(),
    port: term(),
    private: term(),
    query_params: term(),
    query_string: term(),
    remote_ip: term(),
    req_cookies: term(),
    req_headers: term(),
    request_path: term(),
    resp_body: term(),
    resp_cookies: term(),
    resp_headers: term(),
    scheme: term(),
    script_name: term(),
    secret_key_base: term(),
    state: term(),
    status: term()
  },
  String.t()
) :: %Plug.Conn{
  adapter: term(),
  assigns: term(),
  before_send: term(),
  body_params: term(),
  cookies: term(),
  halted: term(),
  host: term(),
  method: term(),
  owner: term(),
  params: term(),
  path_info: term(),
  path_params: term(),
  port: term(),
  private: term(),
  query_params: term(),
  query_string: term(),
  remote_ip: term(),
  req_cookies: term(),
  req_headers: term(),
  request_path: term(),
  resp_body: term(),
  resp_cookies: term(),
  resp_headers: term(),
  scheme: term(),
  script_name: term(),
  secret_key_base: term(),
  state: term(),
  status: term()
}

return the error in json format.

plain_error(conn, error_message)

plain_error(
  %Plug.Conn{
    adapter: term(),
    assigns: term(),
    before_send: term(),
    body_params: term(),
    cookies: term(),
    halted: term(),
    host: term(),
    method: term(),
    owner: term(),
    params: term(),
    path_info: term(),
    path_params: term(),
    port: term(),
    private: term(),
    query_params: term(),
    query_string: term(),
    remote_ip: term(),
    req_cookies: term(),
    req_headers: term(),
    request_path: term(),
    resp_body: term(),
    resp_cookies: term(),
    resp_headers: term(),
    scheme: term(),
    script_name: term(),
    secret_key_base: term(),
    state: term(),
    status: term()
  },
  String.t()
) :: %Plug.Conn{
  adapter: term(),
  assigns: term(),
  before_send: term(),
  body_params: term(),
  cookies: term(),
  halted: term(),
  host: term(),
  method: term(),
  owner: term(),
  params: term(),
  path_info: term(),
  path_params: term(),
  port: term(),
  private: term(),
  query_params: term(),
  query_string: term(),
  remote_ip: term(),
  req_cookies: term(),
  req_headers: term(),
  request_path: term(),
  resp_body: term(),
  resp_cookies: term(),
  resp_headers: term(),
  scheme: term(),
  script_name: term(),
  secret_key_base: term(),
  state: term(),
  status: term()
}

return the error in text plain format.