Interface: FeatureBuilderConfig<O>

See FeatureBuilder.

Type parameters

NameTypeDescription
O{}A type describing the shape of the JSON-serializable object that will be passed to the Web script.

Hierarchy

  • { defaultOptions: Required<O> ; identifier: string ; script: string }

    ↳ FeatureBuilderConfig

Properties

__propSpecs

• Optional __propSpecs: PropsSpecs<any, any>

internal


__webSpecs

• Optional __webSpecs: WebHandlersSpecs<any>

internal


defaultOptions

• Readonly defaultOptions: Required<O>

Inherited from __type.defaultOptions

These options will be shallow-merged with the options provided to the FeatureClass.


identifier

• Readonly identifier: string

Inherited from __type.identifier

A unique identifier of the feature. The convention is to use a reverse namespace domain ending with the feature name.

example org.formidable-webview/webshell.link-press


script

• Readonly script: string

Inherited from __type.script

The string containing valid ECMAScript 5 to be run in the WebView.

remarks The script must define a single function which only argument is of the type WebjsContext.

It is recommended that you use eslint to validate this script syntax, and event better, unit-test the script. See our repository home page for more information.