A minimal observable of state changes. For more information, see the observable proposal: https://github.com/tc39/proposal-observable
The minimal observable subscription method.
Any object that can be used as an observer.
The observer object should have a next method.
An object with an unsubscribe method that can
be used to unsubscribe the observable from the store, and prevent further
emission of values from the observable.
An Observer is used to receive data from an Observable, and is supplied as an argument to subscribe.
A ranked tester associates a tester with a number.
A reducer (also called a reducing function) is a function that accepts an accumulation and a value and returns a new accumulation. They are used to reduce a collection of values down to a single value
Reducers are not unique to Redux—they are a fundamental concept in
functional programming. Even most non-functional languages, like
JavaScript, have a built-in API for reducing. In JavaScript, it's
Array.prototype.reduce().
In Redux, the accumulated value is the state object, and the values being accumulated are actions. Reducers calculate a new state given the previous state and an action. They must be pure functions—functions that return the exact same output for given inputs. They should also be free of side-effects. This is what enables exciting features like hot reloading and time travel.
Reducers are the most important concept in Redux.
Do not put API calls into reducers.
A tester is a function that receives an UI schema and a JSON schema and returns a boolean.
Function to remove listener added by Store.subscribe().
Constant that indicates that a tester is not capable of handling a combination of schema/data.
Synonym for isObjectArrayControl
Default tester for boolean.
Tests whether the given UI schema is of type Control and if the schema has a 'date' format.
Tests whether the given UI schema is of type Control and if the schema has a 'date-time' format.
Tests whether the given UI schema is of type Control and if the schema has an enum.
Tests whether the given UI schema is of type Control and if the schema is of type integer
Tests whether the given UI schema is of type Control and if is has a 'multi' option.
Tests whether the given UI schema is of type Control and if the schema is of type number
Tests whether the given UI schema is of type Control, if the schema is of type string and has option format
Tests whether the given schema is an array of objects.
Tests whether the given UI schema is of type Control and if the schema is an array of objects.
Tests whether the given UI schema is of type Control and if the schema has an enum based on oneOf.
Tests whether the given UI schema is of type Control and if the schema is an array of a primitive type.
Tests whether a given UI schema is of type Control, if the schema is of type number or integer and whether the schema defines a numerical range with a default value.
Tests whether the given UI schema is of type Control and if the schema is of type string
Tests whether the given UI schema is of type Control and if the schema has a 'time' format.
Synonym for mapDispatchToControlProps.
Adds the given {@code labelName} to the {@code layout} if it exists
The layout which is to receive the label The name of the schemaAdds an asterisk to the given label string based on the required parameter.
the label string
whether the label belongs to a control which is required
the label string
Escape the given string such that it can be used as a class name, i.e. hashes and slashes will be replaced.
the string that should be converted to a valid class name
the escaped string
Creates a IControlObject with the given label referencing the given ref
Create a default value based on the given scheam.
the schema for which to create a default value.
Return a label object based on the given control and schema element.
the UI schema to obtain a label object for
optional: the corresponding schema element
Creates a new ILayout.
The type of the laoyut
the new ILayout
Default dispatch to control props which can be customized to set handleChange action
Default mapStateToCellProps for enum cell. Options is used for populating dropdown list
Derives the type of the jsonSchema element
The dereference options control how JSON Schema $Ref Parser will dereference $ref pointers within the JSON schema.
Determines whether circular $ref pointers are handled.
If set to false, then a ReferenceError will be thrown if the schema contains any circular references.
If set to "ignore", then circular references will simply be ignored. No error will be thrown, but the $Refs.circular property will still be set to true.
The parse options determine how different types of files will be parsed.
JSON Schema $Ref Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add your own custom parsers if you want.
The resolve options control how JSON Schema $Ref Parser will resolve file paths and URLs, and how those files will be read/downloaded.
JSON Schema $Ref Parser comes with built-in support for HTTP and HTTPS, as well as support for local files (when running in Node.js). You can configure or disable either of these built-in resolvers. You can also add your own custom resolvers if you want.
Determines whether external $ref pointers will be resolved. If this option is disabled, then external $ref pointers will simply be ignored.
Finds all references inside the given schema.
The JsonSchema to find the references in
The initial result map, default: empty map (this parameter is used for recursion inside the function)
Whether arrays of tuples should be considered; default: false
Finds a registered UI schema to use, if any.
the JSON schema describing the data to be rendered
the according schema path
the instance path
the type of the layout to use
may be checked for embedded inline uischema options
Only applicable for Controls.
This function checks whether the given UI schema is of type Control and if so, resolves the sub-schema referenced by the control and checks whether the format of the sub-schema matches the expected one.
the expected format of the resolved sub-schema
Generate a default UI schema.
the JSON schema to generated a UI schema for
the desired layout type for the root layout of the generated UI schema
Generate a JSON schema based on the given data and any additional options.
the data to create a JSON schema for
any additional options that may alter the generated JSON schema
the generated schema
Returns whether the given {@code jsonSchema} is a combinator ({@code oneOf}, {@code anyOf}, {@code allOf}) at the root level
the schema to checkWhether an element's description should be hidden.
whether an element is visible
the element's description
whether the element is focused
true, if the description is to be hidden, false otherwise
Maps state to dispatch properties of an array control.
the store's dispatch method
dispatch props of an array control
Map dispatch to control props.
dispatch props for a control
Map state to all of renderer props.
the store's state
any own props
state props for a combinator
Map state to table props
the store's state
any element's own props
state props for a table control
Map state to table props
the store's state
any element's own props
state props for a table control
Map state to cell props.
JSONForms state tree
any own props
state props of a cell
Map state to control props.
the store's state
any own props
state props for a control
Map state to control with detail props
the store's state
any element's own props
state props for a table control
Default mapStateToCellProps for enum control. Options is used for populating dropdown list
Map state to layout props.
JSONForms state tree
any own props
Map state to control props.
the store's state
any own props
state props for a control
Default mapStateToCellProps for enum control based on oneOf. Options is used for populating dropdown list
Checks whether the given UI schema has an option with the given name and whether it has the expected value. If no options property is set, returns false.
the name of the option to check
the expected value of the option
Create a ranked tester that will associate a number with a given tester, if the latter returns true.
the rank to be returned in case the tester returns true
a tester
Resolve the given schema path in order to obtain a subschema.
the root schema from which to start
the schema path to be resolved
the actual root schema
the resolved sub-schema
Normalizes the schema and resolves the given ref.
the JSON schema to resolved the reference against
the reference to be resolved
the resolved sub-schema
Only applicable for Controls.
This function checks whether the given UI schema is of type Control and if so, resolves the sub-schema referenced by the control and applies the given predicate
the predicate that should be applied to the resolved sub-schema
Only applicable for Controls.
This function checks whether the given UI schema is of type Control and if so, resolves the sub-schema referenced by the control and checks whether the type of the sub-schema matches the expected one.
the expected type of the resolved sub-schema
Only applicable for Controls.
Checks whether the last segment of the scope matches the expected string.
the expected ending of the reference
Only applicable for Controls.
Checks whether the scope of a control ends with the expected string.
the expected ending of the reference
Remove all schema-specific keywords (e.g. 'properties') from a given path.
the schema path to be converted
the path without schema-specific keywords
Convert a schema path (i.e. JSON pointer) to an array by splitting at the '/' character and removing all schema-specific keywords.
The returned value can be used to de-reference a root object by folding over it and de-referencing the single segments to obtain a new object.
the schema path to be converted
an array containing only non-schema-specific segments
Checks whether the given UI schema has the expected type.
the expected UI schema type
Wraps the given {@code uiSchema} in a Layout if there is none already.
The ui schema to wrap in a layout.
The type of the layout to create.
the wrapped uiSchema.
Convenience wrapper around resolveData and resolveSchema.
Generated using TypeDoc
A dispatching function (or simply dispatch function) is a function that accepts an action or an async action; it then may or may not dispatch one or more actions to the store.
We must distinguish between dispatching functions in general and the base
dispatchfunction provided by the store instance without any middleware.The base dispatch function always synchronously sends an action to the store's reducer, along with the previous state returned by the store, to calculate a new state. It expects actions to be plain objects ready to be consumed by the reducer.
Middleware wraps the base dispatch function. It allows the dispatch function to handle async actions in addition to actions. Middleware may transform, delay, ignore, or otherwise interpret actions or async actions before passing them to the next middleware.
A The type of things (actions or otherwise) which may be dispatched.