Class Ring

Circular chain of websites.

Hierarchy

Ring

Index

Properties

current first last

Accessors

Methods

[iterator] install fetch

Properties

current

current: Site

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

first

first: Site

First memeber of the ring.

last

last: Site

Last member of the ring.

Accessors

random

get random(): Site
Random member of the ring. Guaranteed to not be the same as the current.

Returns Site
- Defined in main.ts:70

Methods

[iterator]

[iterator](): Generator<Site, void, unknown>
Iterates over actual members of the ring.

Returns Generator<Site, void, unknown>
- Defined in main.ts:219

install

install(): void
Does install for the links with the following DOM IDs:
- lwr-first
- lwr-current
- lwr-last
- lwr-random
- lwr-prev
- lwr-next
Returns void
- Defined in main.ts:191

`Static` fetch

fetch(url: string, hint?: string): Promise<Ring>
Creates a ring from a remote JSON file.

Returns
A ring object.

Throws
TypeError If the ring is malformed.
Parameters
- url: string
  
  URL of the JSON file.
- Optional hint: string
  
  URL of the page, on which the library is used.
Returns Promise<Ring>
- Defined in main.ts:172

Generated using TypeDoc