Class MetronClient

constructor

• new MetronClient(options?: MetronClientOptions): MetronClient

  Parameters

  • options: MetronClientOptions = ...

  Returns MetronClient

arc

autoThrottle

baseUrl

character

creator

imprint

issue

maxRetries

publisher

rateLimiter

role

series

seriesType

team

token

universe

userAgent

getRateLimitStatus

• getRateLimitStatus(): RateLimitStatus

  Last known state of both rate-limit counters, as reported by the most recent response. Each counter is null until a request has been made.

  Returns RateLimitStatus

paginate

• paginate(
      path: string,
      params?: Record<string, string | number | boolean | null | undefined>,
  ): AsyncGenerator<any, any, any>

  Async generator yielding every result across all pages of a list endpoint, sleeping/retrying as needed between page requests so callers never have to think about the rate limit themselves.

  Parameters

  • path: string
  • Optionalparams: Record<string, string | number | boolean | null | undefined> = {}

  Returns AsyncGenerator<any, any, any>

request

• request(
      path: string,
      params?: Record<string, string | number | boolean | null | undefined>,
  ): Promise<any>

  Issue a GET request against a Metron API path, e.g. /api/series/. Prefer the resource namespaces (client.series.list(...), etc.) for the built-in endpoints; this is the low-level primitive they're built on.

  Parameters

  • path: string
  • Optionalparams: Record<string, string | number | boolean | null | undefined> = {}

  Returns Promise<any>