Upgrading @appium/types from 1.x to 2.x
Comparison of the public API of @appium/types 1.7.2 and 2.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.
Summary
| Removed import paths | 0 |
|---|---|
| Removed exports | 11 |
| Changed signatures | 20 |
| Removed class or interface members | 38 |
| Changed class or interface members | 52 |
| Newly deprecated | 4 |
| Requirement changes (engines, peer dependencies) | 2 |
| New exports | 27 |
Removed exports
| import | export | kind | Before |
|---|---|---|---|
@appium/types | Location | interface | interface |
@appium/types | DriverData | type | { [x: string]: unknown; } |
@appium/types | TraceDirConfig | type | string |
@appium/types | AllowCorsConfig | type | boolean |
@appium/types | NodeconfigConfig | interface | interface |
@appium/types | StrictCapsConfig | type | boolean |
@appium/types | CallbackPortConfig | type | number |
@appium/types | SingularSessionData | type | ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly isBoolean: true; }; re… |
@appium/types | CallbackAddressConfig | type | string |
@appium/types | DebugLogSpacingConfig | type | boolean |
@appium/types | LegacyCreateSessionArgs | type | [w3cCaps1: W3CDriverCaps<C>, w3cCaps2?: W3CDriverCaps<C> | undefined, w3cCaps3?: W3CDriverCaps<C> | undefined, driverData?: DriverData[] | undefined] |
Changed signatures
| export | Before | After |
|---|---|---|
@appium/types · Class | any | { new (...args: Args): Proto; prototype: Pick<Proto, keyof Proto>; } & StaticMembers |
@appium/types · MethodMap | T extends Plugin ? Readonly<PluginMethodMap<T>> : T extends Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord> ? Readonly<DriverMethodMap<T>> : never | T extends Plugin ? Readonly<PluginMethodMap<T>> : T extends Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void> ? Readonly<DriverMethodMap<T>> : never |
@appium/types · DriverCaps | ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly isBoolean: true; }; re… | ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { readonly isBoolean: true; }; }> & ConstraintsToCaps<C> |
@appium/types · DriverOpts | any | { [x: string]: any; fastReset?: boolean | undefined; skipUninstall?: boolean | undefined; } & ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { … |
@appium/types · DriverClass | any | { new (...args: [] | [Partial<ServerArgs>] | [Partial<ServerArgs>, boolean]): T; prototype: Pick<T, keyof T>; } & DriverStatic<T> |
@appium/types · InitialOpts | Merge<ServerArgs, ExtraDriverOpts> | { [x: string]: any; fastReset?: boolean | undefined; skipUninstall?: boolean | undefined; } |
@appium/types · PluginClass | any | { new (pluginName: string, cliArgs: StringRecord<unknown>, driverId: string | null): P; prototype: Pick<P, keyof P>; } & PluginStatic<P> |
@appium/types · NSDriverCaps | Partial<CapsToNSCaps<ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly i… | Partial<CapsToNSCaps<ConstraintsToCaps<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { readonly isBoolean: true; }; }>, "appium">> & Partial<CapsToNSCaps<Constr… |
@appium/types · BidiMethodDef | interface | Omit<BaseExecuteMethodDef, "params"> & { command: string; params?: BidiMethodParams | undefined; } |
@appium/types · BaseCapabilities | { platformName: string; app: string | undefined; platformVersion: string | undefined; webSocketUrl: boolean | undefined; newCommandTimeout: number | undefined; automationName: string | undefined; autoLaunch: boolean | undefined; udid: string | undefined; orientation: unknown; autoWebview: boolean | undefined; noReset: boolean | undefined; fullReset: boolean | undefined; language: string | undefined; locale: string | undefined; eventTimings: boolean | undefined; printPageSourceOnFindFailure: boolean | undefined; } | { platformName: string; app: string | undefined; platformVersion: string | undefined; webSocketUrl: boolean | undefined; newCommandTimeout: number | undefined; automationName: string | undefined; noReset: boolean | undefined; fullReset: boolean | undefined; printPageSourceOnFindFailure: boolean | undefined; } |
@appium/types · ExecuteMethodMap | T extends Plugin ? Readonly<StringRecord<PluginExecuteMethodDef<T>>> : T extends Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord> ? Readonly<StringRecord<DriverExecuteMethodDef<T>>> : never | T extends Plugin ? Readonly<StringRecord<PluginExecuteMethodDef<T>>> : T extends Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void> ? Readonly<StringRecord<DriverExecuteMethodDef<T>>> : never |
@appium/types · BaseNSCapabilities | { platformName?: string | undefined; "appium:app"?: string | undefined; "appium:platformVersion"?: string | undefined; webSocketUrl?: boolean | undefined; "appium:newCommandTimeout"?: number | undefined; "appium:automationName"?: string | undefined; "appium:autoLaunch"?: boolean | undefined; "appium:udid"?: string | undefined; "appium:orientation"?: unknown; "appium:autoWebview"?: boolean | undefined; "appium:noReset"?: boolean | undefined; "appium:fullReset"?: boolean | undefined; "appium:language"?: string | undefined; "appium:locale"?: string | undefined; "appium:eventTimings"?: boolean | u… | { platformName?: string | undefined; "appium:app"?: string | undefined; "appium:platformVersion"?: string | undefined; webSocketUrl?: boolean | undefined; "appium:newCommandTimeout"?: number | undefined; "appium:automationName"?: string | undefined; "appium:noReset"?: boolean | undefined; "appium:fullReset"?: boolean | undefined; "appium:printPageSourceOnFindFailure"?: boolean | undefined; } |
@appium/types · BaseW3CCapabilities | W3CCapabilities<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly isBoolean: true; }; read… | W3CCapabilities<{ readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { readonly isBoolean: true; }; }> |
@appium/types · IImplementedCommands | IBidiCommands & ILogCommands & IFindCommands & ISettingsCommands<Settings> & ITimeoutCommands & IEventCommands & IExecuteCommands & ISessionHandler<C, CreateResult, DeleteResult, SessionData> | IBidiCommands & ILogCommands & IFindCommands & ISettingsCommands<Settings> & ITimeoutCommands & IEventCommands & IExecuteCommands & ISessionHandler<C, CreateResult, DeleteResult> |
@appium/types · DriverExecuteMethodDef | interface | IsAny<T> extends true ? LooseExecuteMethodDef : CheckedExecuteMethodDef<ConditionalPick<T, DriverCommand>, "driver"> |
@appium/types · NormalizedServerConfig | { [x: string]: string | number | boolean | AllowInsecureConfig | DenyInsecureConfig | LogFiltersConfig | UseDriversConfig | UsePluginsConfig | DefaultCapabilitiesConfig | DriverConfig | NodeconfigConfig | PluginConfig | undefined; } | { [x: string]: string | number | boolean | AllowInsecureConfig | AppUrlRules | DenyInsecureConfig | LogFiltersConfig | UseDriversConfig | UsePluginsConfig | DefaultCapabilitiesConfig | DriverConfig | PluginConfig | undefined; } |
@appium/types · PluginExecuteMethodDef | interface | IsAny<T> extends true ? LooseExecuteMethodDef : CheckedExecuteMethodDef<ConditionalPick<T, PluginCommand>, "plugin"> |
@appium/types · BaseDriverCapConstraints | { readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly isBoolean: true; }; readonly noReset: { … | { readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { readonly isBoolean: true; }; } |
@appium/types · BASE_DESIRED_CAP_CONSTRAINTS | { readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly autoLaunch: { readonly isBoolean: true; }; readonly udid: { readonly isString: true; }; readonly orientation: { readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"]; }; readonly autoWebview: { readonly isBoolean: true; }; readonly noReset: { … | { readonly platformName: { readonly presence: true; readonly isString: true; }; readonly app: { readonly isString: true; }; readonly platformVersion: { readonly isString: true; }; readonly webSocketUrl: { readonly isBoolean: true; }; readonly newCommandTimeout: { readonly isNumber: true; }; readonly automationName: { readonly isString: true; }; readonly noReset: { readonly isBoolean: true; }; readonly fullReset: { readonly isBoolean: true; }; readonly printPageSourceOnFindFailure: { readonly isBoolean: true; }; } |
@appium/types · DriverCommandToPluginCommand | (next: NextPluginCallback<NextRetval>, driver: ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>, ...args: TArgs) => Promise<TReturn> | (next: NextPluginCallback<NextRetval>, driver: ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>, ...args: TArgs) => Promise<TReturn> |
Removed class or interface members
| member | import | Before |
|---|---|---|
Core.driverData | @appium/types | DriverData |
Core.isMjsonwpProtocol | @appium/types | (): boolean |
Driver.driverData | @appium/types | DriverData |
Driver.getSession | @appium/types | (): Promise<SingularSessionData<C, SessionData>> |
Driver.implicitWaitW3C | @appium/types | (ms: number): Promise<void> |
Driver.scriptTimeoutW3C | @appium/types | (ms: number): Promise<void> |
Driver.isMjsonwpProtocol | @appium/types | (): boolean |
Driver.newCommandTimeout | @appium/types | (ms: number): Promise<void> |
Driver.pageLoadTimeoutW3C | @appium/types | (ms: number): Promise<void> |
Plugin.logger | @appium/types | AppiumLogger |
AppiumLogger.errorAndThrow | @appium/types | (...args: any[]): never |
ServerConfig.trace-dir | @appium/types | string | undefined |
ServerConfig.allow-cors | @appium/types | boolean | undefined |
ServerConfig.nodeconfig | @appium/types | NodeconfigConfig | undefined |
ServerConfig.strict-caps | @appium/types | boolean | undefined |
ServerConfig.callback-port | @appium/types | number | undefined |
ServerConfig.callback-address | @appium/types | string | undefined |
ServerConfig.debug-log-spacing | @appium/types | boolean | undefined |
ExternalDriver.driverData | @appium/types | DriverData |
ExternalDriver.getSession | @appium/types | (): Promise<SingularSessionData<C, SessionData>> |
ExternalDriver.getGeoLocation | @appium/types | (() => Promise<Location>) | undefined |
ExternalDriver.setGeoLocation | @appium/types | ((location: Partial<Location>) => Promise<Location>) | undefined |
ExternalDriver.implicitWaitW3C | @appium/types | (ms: number): Promise<void> |
ExternalDriver.scriptTimeoutW3C | @appium/types | (ms: number): Promise<void> |
ExternalDriver.isMjsonwpProtocol | @appium/types | (): boolean |
ExternalDriver.newCommandTimeout | @appium/types | (ms: number): Promise<void> |
ExternalDriver.pageLoadTimeoutW3C | @appium/types | (ms: number): Promise<void> |
ExternalDriver.getNetworkConnection | @appium/types | (() => Promise<number>) | undefined |
ExternalDriver.setNetworkConnection | @appium/types | ((type: number) => Promise<number>) | undefined |
IJSONWPCommands.getGeoLocation | @appium/types | (() => Promise<Location>) | undefined |
IJSONWPCommands.setGeoLocation | @appium/types | ((location: Partial<Location>) => Promise<Location>) | undefined |
ISessionHandler.getSession | @appium/types | (): Promise<SingularSessionData<C, SessionData>> |
IMJSONWPCommands.getNetworkConnection | @appium/types | (() => Promise<number>) | undefined |
IMJSONWPCommands.setNetworkConnection | @appium/types | ((type: number) => Promise<number>) | undefined |
ITimeoutCommands.implicitWaitW3C | @appium/types | (ms: number): Promise<void> |
ITimeoutCommands.scriptTimeoutW3C | @appium/types | (ms: number): Promise<void> |
ITimeoutCommands.newCommandTimeout | @appium/types | (ms: number): Promise<void> |
ITimeoutCommands.pageLoadTimeoutW3C | @appium/types | (ms: number): Promise<void> |
Changed class or interface members
| member | Before | After |
|---|---|---|
Core.opts | any | DriverOpts<C> |
Core.initialOpts | Merge<ServerArgs, ExtraDriverOpts> | { [x: string]: any; fastReset?: boolean | undefined; skipUninstall?: boolean | undefined; } |
Core.implicitWaitMs | number | TimeoutValue |
Core.addManagedDriver | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>): void | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>): void |
Core.getManagedDrivers | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>[] | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>[] |
Driver.opts | any | DriverOpts<C> |
Driver.timeouts | (type?: string | undefined, ms?: string | number | undefined, script?: number | undefined, pageLoad?: number | undefined, implicit?: string | number | undefined): Promise<void> | (type?: string | undefined, ms?: string | number | undefined, script?: TimeoutValue | undefined, pageLoad?: TimeoutValue | undefined, implicit?: TimeoutValue | undefined, command?: number | undefined): Promise<void> |
Driver.findElOrEls | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: boolean, context?: any): Promise<Element<string> | Element<string>[]> |
Driver.getTimeouts | (): Promise<Record<string, number>> | (): Promise<Timeouts & { command: number; }> |
Driver.initialOpts | Merge<ServerArgs, ExtraDriverOpts> | { [x: string]: any; fastReset?: boolean | undefined; skipUninstall?: boolean | undefined; } |
Driver.getLogEvents | (type?: string | string[] | undefined): Promise<Record<string, number> | EventHistory> | (type?: string | string[] | undefined): Promise<EventHistory | Record<string, number>> |
Driver.bidiSubscribe | (events: string[], contexts?: string[] | undefined): Promise<{ subscription: string; }> | (events: string[], contexts?: string[] | undefined, userContexts?: string[] | undefined): Promise<{ subscription: string; }> |
Driver.createSession | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> | (w3cCaps1: W3CDriverCaps<C>, w3cCaps2?: W3CDriverCaps<C> | undefined, w3cCaps3?: W3CDriverCaps<C> | undefined, driverData?: DriverData[] | undefined): Promise<CreateResult> | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> |
Driver.deleteSession | (sessionId?: string | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined, driverData?: DriverData[] | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined): Promise<void | DeleteResult> |
Driver.implicitWaitMs | number | TimeoutValue |
Driver.setImplicitWait | (ms: number): void | (ms: TimeoutValue): void |
Driver.addManagedDriver | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>): void | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>): void |
Driver.getManagedDrivers | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>[] | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>[] |
Plugin.handle | PluginCommand<ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>, [cmdName: string, ...args: any[]], void, unknown> | undefined | PluginCommand<ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>, [cmdName: string, ...args: any[]], void, unknown> | undefined |
Plugin.cliArgs | Record<string, any> | Readonly<Record<string, any>> |
Plugin.onUnexpectedShutdown | ((driver: ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>, cause: string | Error) => Promise<void>) | undefined | ((driver: ExternalDriver<Constraints, string, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>, cause: string | Error) => Promise<void>) | undefined |
DriverHelpers.generateDriverLogPrefix | (obj: object, sessionId?: string | undefined): string | (obj: object): string |
IBidiCommands.bidiSubscribe | (events: string[], contexts?: string[] | undefined): Promise<{ subscription: string; }> | (events: string[], contexts?: string[] | undefined, userContexts?: string[] | undefined): Promise<{ subscription: string; }> |
IFindCommands.findElOrEls | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: boolean, context?: any): Promise<Element<string> | Element<string>[]> |
PayloadParams.required | any | readonly string[] | readonly (readonly string[])[] | undefined |
PayloadParams.validate | ((obj: any, protocol: string) => string | boolean | undefined) | undefined | ((obj: any) => string | boolean | undefined) | undefined |
ExternalDriver.opts | any | DriverOpts<C> |
ExternalDriver.timeouts | (type?: string | undefined, ms?: string | number | undefined, script?: number | undefined, pageLoad?: number | undefined, implicit?: string | number | undefined): Promise<void> | (type?: string | undefined, ms?: string | number | undefined, script?: TimeoutValue | undefined, pageLoad?: TimeoutValue | undefined, implicit?: TimeoutValue | undefined, command?: number | undefined): Promise<void> |
ExternalDriver.findElOrEls | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: true, context?: any): Promise<Element<string>[]> | (strategy: string, selector: string, mult: false, context?: any): Promise<Element<string>> | (strategy: string, selector: string, mult: boolean, context?: any): Promise<Element<string> | Element<string>[]> |
ExternalDriver.getTimeouts | (): Promise<Record<string, number>> | (): Promise<Timeouts & { command: number; }> |
ExternalDriver.initialOpts | Merge<ServerArgs, ExtraDriverOpts> | { [x: string]: any; fastReset?: boolean | undefined; skipUninstall?: boolean | undefined; } |
ExternalDriver.getLogEvents | (type?: string | string[] | undefined): Promise<Record<string, number> | EventHistory> | (type?: string | string[] | undefined): Promise<EventHistory | Record<string, number>> |
ExternalDriver.bidiSubscribe | (events: string[], contexts?: string[] | undefined): Promise<{ subscription: string; }> | (events: string[], contexts?: string[] | undefined, userContexts?: string[] | undefined): Promise<{ subscription: string; }> |
ExternalDriver.createSession | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> | (w3cCaps1: W3CDriverCaps<C>, w3cCaps2?: W3CDriverCaps<C> | undefined, w3cCaps3?: W3CDriverCaps<C> | undefined, driverData?: DriverData[] | undefined): Promise<CreateResult> | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> |
ExternalDriver.deleteSession | (sessionId?: string | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined, driverData?: DriverData[] | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined): Promise<void | DeleteResult> |
ExternalDriver.implicitWaitMs | number | TimeoutValue |
ExternalDriver.setImplicitWait | (ms: number): void | (ms: TimeoutValue): void |
ExternalDriver.addManagedDriver | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>): void | (driver: Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>): void |
ExternalDriver.getManagedDrivers | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void, StringRecord>[] | (): Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void>[] |
IEventCommands.getLogEvents | (type?: string | string[] | undefined): Promise<Record<string, number> | EventHistory> | (type?: string | string[] | undefined): Promise<EventHistory | Record<string, number>> |
DriverMethodDef.command | (D extends true ? string : string | number | symbol) | undefined | (D extends true ? string : ConditionalKeys<Required<T>, DriverCommand>) | undefined |
ISessionHandler.createSession | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> | (w3cCaps1: W3CDriverCaps<C>, w3cCaps2?: W3CDriverCaps<C> | undefined, w3cCaps3?: W3CDriverCaps<C> | undefined, driverData?: DriverData[] | undefined): Promise<CreateResult> | (w3cCapabilities: W3CDriverCaps<C>): Promise<CreateResult> |
ISessionHandler.deleteSession | (sessionId?: string | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined, driverData?: DriverData[] | undefined): Promise<void | DeleteResult> | (sessionId?: string | undefined): Promise<void | DeleteResult> |
PluginMethodDef.command | string | number | symbol | undefined | ConditionalKeys<Required<T>, PluginCommand> | undefined |
W3CCapabilities.firstMatch | Partial<CapsToNSCaps<ConstraintsToCaps<C>, "appium">>[] | Partial<CapsToNSCaps<ConstraintsToCaps<C>, "appium">>[] | undefined |
W3CCapabilities.alwaysMatch | Partial<CapsToNSCaps<ConstraintsToCaps<C>, "appium">> | Partial<CapsToNSCaps<ConstraintsToCaps<C>, "appium">> | undefined |
BidiMethodParams.required | readonly string[] | undefined | readonly string[] | readonly (readonly string[])[] | undefined |
ExecuteMethodDef.command | string | number | symbol | ConditionalKeys<Required<Ext>, Ext extends Plugin ? PluginCommand : Ext extends Driver<Constraints, StringRecord, StringRecord, DefaultCreateSessionResult<Constraints>, void> ? DriverCommand : never> |
ITimeoutCommands.timeouts | (type?: string | undefined, ms?: string | number | undefined, script?: number | undefined, pageLoad?: number | undefined, implicit?: string | number | undefined): Promise<void> | (type?: string | undefined, ms?: string | number | undefined, script?: TimeoutValue | undefined, pageLoad?: TimeoutValue | undefined, implicit?: TimeoutValue | undefined, command?: number | undefined): Promise<void> |
ITimeoutCommands.getTimeouts | (): Promise<Record<string, number>> | (): Promise<Timeouts & { command: number; }> |
ITimeoutCommands.setImplicitWait | (ms: number): void | (ms: TimeoutValue): void |
StandardCapabilities.timeouts | Timeouts | undefined | Partial<Timeouts> | undefined |
Newly deprecated
| export | @deprecated |
|---|---|
@appium/types · Core.protocol | Ignored. Responses are always W3C. Removed in Appium 5. |
@appium/types · Driver.protocol | Ignored. Responses are always W3C. Removed in Appium 5. |
@appium/types · Protocol | Ignored. Responses are always W3C. Removed in Appium 5. |
@appium/types · ExternalDriver.protocol | Ignored. Responses are always W3C. Removed in Appium 5. |
Requirement changes (engines, peer dependencies)
| Before | After | |
|---|---|---|
engines.node | ^20.19.0 || ^22.12.0 || >=24.0.0 | ^22.22.2 || ^24.15.0 || >=26.0.0 |
peerDependencies.@appium/logger | ^2.0.0 | ^3.0.0-beta.0 |
New exports (27)
| import | export | kind |
|---|---|---|
@appium/types | IsAny | type |
@appium/types | Merge | type |
@appium/types | IsNever | type |
@appium/types | Jsonify | type |
@appium/types | Simplify | type |
@appium/types | Timeouts | type |
@appium/types | BiDiEvent | interface |
@appium/types | JsonArray | type |
@appium/types | JsonValue | type |
@appium/types | JsonObject | type |
@appium/types | AppUrlRules | interface |
@appium/types | KeyAsString | type |
@appium/types | PackageJson | interface |
@appium/types | SetOptional | type |
@appium/types | SetRequired | type |
@appium/types | TimeoutValue | type |
@appium/types | JsonPrimitive | type |
@appium/types | MergeExclusive | type |
@appium/types | ConditionalPick | type |
@appium/types | AppUrlRulesConfig | type |
@appium/types | BiDiEventDelivery | interface |
@appium/types | RequireAtLeastOne | type |
@appium/types | BiDiBackpressureEvent | interface |
@appium/types | BidiMaxBufferedMsConfig | type |
@appium/types | BidiMaxBufferedBytesConfig | type |
@appium/types | BidiHeartbeatIntervalConfig | type |
@appium/types | MultidimensionalReadonlyArray | type |
Give your AI agent these facts
Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.
claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp
Add to CursorAdd to VS Code★ Star on GitHub
Any other MCP client
{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests
Frequently asked questions
What are the breaking changes when upgrading @appium/types from 1 to 2?
Between @appium/types 1.7.2 and 2.0.0, Vigia found 11 removed exports, 20 changed signatures and 90 removed or changed class or interface members.
What became deprecated in @appium/types 2?
4 exports or members are newly marked as deprecated in @appium/types 2.0.0.
For agents
GET https://vigia.coredls.cloud/v1/packages/npm/@appium/types/upgrade?from=1.7.2&to=2.0.0