Skip to content

Interface: PluginMethodDef<T>

@appium/types.PluginMethodDef

A definition of an exposed API command in a Plugin.

Type parameters

Name Type
T extends Plugin

Hierarchy

PluginMethodDef

Table of contents

Properties

Properties

command

Optional Readonly command: ConditionalKeys<Required<T>, DriverCommand>

Name of the command.

Defined in

node_modules/@appium/types/lib/command.ts:87


neverProxy

Optional Readonly neverProxy: boolean

If true, this Method will never proxy.

Inherited from

BaseMethodDef.neverProxy

Defined in

node_modules/@appium/types/lib/command.ts:57


payloadParams

Optional Readonly payloadParams: PayloadParams

Specifies shape of payload

Inherited from

BaseMethodDef.payloadParams

Defined in

node_modules/@appium/types/lib/command.ts:61