BF Utility Functions
BetterForm has a collection of helper Java Script functions that are used within JavaScript to allow easy access to common complex code.
Actions
BF.actionsClear()
Clears the action script buffer halting all subsequent actions (current action completes)
Errors
BF.errorClearAll()
Clears the error cache
BF.errorGetAll()
Returns all current errors
BF.errorThrow(errorCode, errorDescription, info)
Creates an error
Actions
BF.namedAction(name, options)
Runs a named action, options are propagated to all actions within the named action.
Misc
BF.getPaths(object, JPquery)
Returns JSONPath query on passed object
BF.getQueryParam(key)
Returns the URL query key value
BF.i18n(key)
Internationalization translations. Returns the key's value in its correct language.
BF.getUUID()
Returns a UUID
BF.pwaSetManifest(manifest)
Sets the manifest for PWA apps. manifest is a JSON object that confirms to a standard PWA manifest object.
BF.getVersion()
Returns an object with version info: { basecode, app }.
basecode is the BF operating system version. app is the published app version (from the evironments card if present, otherwise falls back to site.hash).
Available in basecode v3.2.19+.
BF.rebuildReactivity(object)
This function is normally run upon the completion of a function internally by the BF actions processor.
It recursively scans the object passed and adds new reactive keys to keys that are new or do not have reactivity. You will not need to use this within a function unless that function has a callback that later mutates a reactive object. Eg: setTimeout() which takes a callback.
BF.socketConnect()
Connects the client to the BF server via a socket
BF.socketDisconnect()
Disconnects the client from the BF servers (Goes off line)
Last updated