themeparks

Install the themeparks library using npm to access ride wait times and park opening times for various theme parks.

npm install themeparks --save

You can enable debug mode using the standard NODE_DEBUG environment variable. Pass themeparks to see debug logs during execution.

To debug an online test:

NODE_DEBUG=themeparks npm run testonline

To combine multiple environment variables (e.g., debugging a specific park):

NODE_DEBUG=themeparks PARKID=UniversalStudiosFlorida npm run testonline

The library uses mocha for testing. You can run offline functional unit tests or online tests that verify actual connections to park APIs.

Offline Unit Tests Run these to test the library's logic without making network requests:

npm test

Or run against source files directly:

npm run testdev

Online Tests Run these to check if the library still connects to park APIs correctly:

npm run testonline

To test a specific park during an online test, set the PARKID environment variable:

PARKID=UniversalStudiosFlorida npm run testonline

The Schedule class automatically manages its own persistence via an internal Cache instance.

1. Initialization: When a Schedule is created, it calls CheckCacheStatus(). This returns a Promise that resolves once the cache has been successfully read from storage.
2. Automatic Writes: Whenever SetDate or SetRange modifies the schedule, the class calls RequestCache(), which schedules a write to the cache after a 500ms debounce period.
3. Data Retention: During a write, the class automatically purges schedule data older than 3 days to keep the cache size manageable.
4. Manual Access: You can access the underlying cache instance via the Cache getter.

You can modify global library behavior by editing the properties of the Themeparks.Settings object. These settings affect caching and request timeouts.

// Example of setting a custom cache location
const Themeparks = require("themeparks");
Themeparks.Settings.Cache = __dirname + "/themeparks.db";

The FetchWaitTimes() method retrieves ride status and wait times from the SixFlags API. It maps the API's status strings to internal status and wait time values:

The library provides two ways to access the collection of supported theme park modules:

1. AllParks: An array containing all available park modules. This is useful for iterating through all supported parks.
2. Parks: A keyed object where each property name corresponds to a specific park module. This is useful for direct access to a specific park by its identifier.

Each park module in these collections provides the API for interacting with that specific theme park's data (e.g., ride wait times, schedules).

const { AllParks, Parks } = require('themeparks');

// Iterate through all parks
AllParks.forEach(park => {
  console.log(park.name);
});

// Access a specific park directly
const magicKingdom = Parks.WaltDisneyWorldMagicKingdom;
console.log(magicKingdom.name);

To use the library, you can import themeparks and iterate over its Parks collection to instantiate specific park objects. This is useful for pre-loading park data into memory for fast access.

const ThemeParks = require("themeparks");

// construct our park objects and keep them in memory for fast access later
const Parks = {};
for (const park in ThemeParks.Parks) {
  Parks[park] = new ThemeParks.Parks[park]();
}

// print each park's name, current location, and timezone
for (const park in Parks) {
  console.log(`* ${Parks[park].Name} [${Parks[park].LocationString}]: (${Parks[park].Timezone})`);
}

If you need to route requests through a proxy, pass a proxyAgent (an instance of an http.Agent) in the options object when constructing a park class.

// include the Themeparks library
const Themeparks = require("themeparks");

// include whichever proxy library you want to use (must provide an http.Agent object)
const SocksProxyAgent = require('socks-proxy-agent');

// create your proxy agent object
const MyProxy = new SocksProxyAgent("socks://socks-proxy-host", true);

// create your park object, passing in proxyAgent as an option
const DisneyWorldMagicKingdom = new Themeparks.Parks.WaltDisneyWorldMagicKingdom({
    proxyAgent: MyProxy
});