Skip to content

Interface: DriverMethodDef<T, D>

@appium/types.DriverMethodDef

A definition of an exposed API command in a Driver.

Type parameters

Name Type
T extends Driver
D extends boolean = boolean

Hierarchy

DriverMethodDef

Table of contents

Properties

Properties

command

Optional Readonly command: D extends true ? string : ConditionalKeys<Required<T>, DriverCommand>

Name of the command.

Defined in

packages/types/lib/command.ts:72


deprecated

Optional Readonly deprecated: D

If this is true, we do not validate command, because it may not exist in ExternalDriver.

Defined in

packages/types/lib/command.ts:77


neverProxy

Optional Readonly neverProxy: boolean

If true, this Method will never proxy.

Inherited from

BaseMethodDef.neverProxy

Defined in

packages/types/lib/command.ts:57


payloadParams

Optional Readonly payloadParams: PayloadParams

Specifies shape of payload

Inherited from

BaseMethodDef.payloadParams

Defined in

packages/types/lib/command.ts:61