Skip to content
Shoal
Shoal
You’re reading the docs for an older version. v1.xGo to the latest docs →

Reference

Configuration

Constructor options for shoal-js v1.

JavaScript
new Shoal(key, {
  refresh: 60,        // seconds between polls
  host: "https://api.shoal.dev",
  timeout: 5,         // seconds
  offline: false,     // serve defaults only
});
OptionDefaultDescription
refresh60Polling interval in seconds
hosthttps://api.shoal.devAPI host
timeout5Request timeout in seconds
offlinefalseNever call the network; serve defaults
Was this page helpful?

Type to search. Results come from a local index — nothing leaves your browser.

↑ ↓ to navigate↵ to openMiniSearch · local