Lightning.Extensions.RateLimiting behaviour (Lightning v2.13.5-pre)

View Source

Rate limiting for Lightning API endpoints.

Summary

Types

message()
request_error()

Callbacks

limit_request(conn, context, opts)

Types

message()

@type message() :: Lightning.Extensions.Message.t()

request_error()

@type request_error() :: :too_many_requests | :unknown

Callbacks

limit_request(conn, context, opts)

@callback limit_request(
  conn :: Plug.Conn.t(),
  context :: Lightning.Extensions.RateLimiting.Context.t(),
  opts :: Keyword.t()
) :: :ok | {:error, request_error(), message()}