shopify_graphql v2.1.0

Shopify.GraphQL.Limiter (shopify_graphql v2.1.0)

Link to this section Summary

Types

name_t()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

send(limiter, request, config)
start_link(opts)
start_partition(limiter, config)
throttled?(limiter, config)

Returns true if requests are currently being throttled due to rate limiting. Otherwise, returns false.

Link to this section Types

Link to this type

name_t()

@type name_t() :: atom() | {:global, any()} | {:via, module(), any()}

Link to this section Functions

Link to this function

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

send(limiter, request, config)

@spec send(name_t(), Shopify.GraphQL.Request.t(), Shopify.GraphQL.Config.t()) ::
  Shopify.GraphQL.http_response_t()
Link to this function

start_link(opts)

@spec start_link(Keyword.t()) :: Supervisor.on_start()
Link to this function

start_partition(limiter, config)

@spec start_partition(name_t(), Shopify.GraphQL.Config.t()) ::
  {:ok, pid()} | {:error, term()}
Link to this function

throttled?(limiter, config)

@spec throttled?(name_t(), Keyword.t()) :: boolean()

Returns true if requests are currently being throttled due to rate limiting. Otherwise, returns false.