Class Ring

current

first

last

random

• get random(): Site

• Random member of the ring. Guaranteed to not be the same as the current.

  Returns Site

[iterator]

• [iterator](): Generator<Site, void, unknown>

• Iterates over actual members of the ring.

  Returns Generator<Site, void, unknown>

install

• install(): void

• Does Site#install for the links with the following DOM IDs:

  • lwr-first
  • lwr-current
  • lwr-last
  • lwr-random
  • lwr-prev
  • lwr-next

  Returns void

Static fetch

• fetch(url, hint?): Promise<Ring>

• Creates a ring from a remote JSON file.

  Parameters

  • url: string

    URL of the JSON file.

  • Optional hint: string

    URL of the page, on which the library is used.

  Returns Promise<Ring>

  A ring object.

  Throws

  TypeError If the ring is malformed.