Class PluginVerifier

Plugin class for verifying and validating other Lens Studio plugins through automated testing.

Hierarchy (View Summary)

IPlugin
- PluginVerifier

Index

Constructors

Properties

id pluginSystem

Methods

getTypeName isOfType isSame verify

Constructors

constructor

new PluginVerifier(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): PluginVerifier
Constructs a PluginVerifier instance bound to the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns PluginVerifier
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance this verifier operates within.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

verify

verify(pluginDescriptor: IPluginDescriptor, outputDir: Path): Promise<void>
Runs verification tests against a plugin descriptor and writes output artifacts to the specified directory.
Parameters
- pluginDescriptor: IPluginDescriptor
- outputDir: Path
Returns Promise<void>