Skip to content

QueryStringMachineModule

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/query-string-machine/blob/main/js/QueryStringMachineModule.ts for the most up-to-date information.

Overview

Type QSMParsedParameters

import type { QSMParsedParameters } from 'scenerystack/query-string-machine';

{ // Will return a map of the "result" types [Property in keyof SchemaMap]: QueryMachineTypeToType<SchemaMap[ Property ][ 'type' ]> // SCHEMA_MAP allowed to be set in types } & { SCHEMA_MAP: SchemaMap }

Type QSMSchemaObject

import type { QSMSchemaObject } from 'scenerystack/query-string-machine';

Record<string, Schema>

Type Warning

import type { Warning } from 'scenerystack/query-string-machine';
  • key: string
  • value: string
  • message: string

Source Code

See the source for QueryStringMachineModule.ts in the query-string-machine repository.