Namespace: WrapperUtils

WrapperUtils

A collection of utility functions and constants for creating PhET-iO wrappers. Available in the main PhET-iO js import.

Members

(static) PHET_IO_LIB_ABSOLUTE_PATH

(static, constant) SIMULATION_NAME

The hyphenated name of the simulation

(static, constant) SIMULATION_VERSION

The version of the simulation

Methods

(static) appendQueryString(url, queryParameters) → {string}

Appends a query string to a given url.
Parameters:
Name Type Description
url may or may not already have other query parameters
queryParameters may start with '', '?' or '&'
Returns:
Type
string

(static) appendQueryStringArray(url, queryStringArray) → {string}

Helper function for multiple query strings
Parameters:
Name Type Description
url string may or may not already have other query parameters
queryStringArray Array.<string> each item may start with '', '?', or '&'
Returns:
Type
string

(static) getSim(optionsopt) → {WrapperUtilsSimData}

Get information about the simulation that can be used for SimIFrameClient and general wrapper development
Parameters:
Name Type Attributes Description
options Object <optional>
{name} name, {string} absolutePath, {boolean} debug, {string} relativeDots
Returns:
Type
WrapperUtilsSimData