UNPKG

@appium/base-driver

Version:

Base driver class for Appium drivers

36 lines 1.35 kB
/** * Maximum size (in bytes) of a given driver's settings object (which is internal to {@linkcode DriverSettings}). */ export const MAX_SETTINGS_SIZE: number; /** * @template {StringRecord} T * @implements {IDeviceSettings<T>} */ export class DeviceSettings<T extends StringRecord> implements IDeviceSettings<T> { /** * Creates a _shallow copy_ of the `defaultSettings` parameter! * @param {T} [defaultSettings] * @param {import('@appium/types').SettingsUpdateListener<T>} [onSettingsUpdate] */ constructor(defaultSettings?: T, onSettingsUpdate?: import("@appium/types").SettingsUpdateListener<T>); /** * @protected * @type {T} */ protected _settings: T; /** * @protected * @type {import('@appium/types').SettingsUpdateListener<T>} */ protected _onSettingsUpdate: import("@appium/types").SettingsUpdateListener<T>; /** * calls updateSettings from implementing driver every time a setting is changed. * @param {T} newSettings */ update(newSettings: T): Promise<void>; getSettings(): T; } export default DeviceSettings; export type StringRecord = import("@appium/types").StringRecord; export type IDeviceSettings<T extends StringRecord = StringRecord> = import("@appium/types").IDeviceSettings<T>; //# sourceMappingURL=device-settings.d.ts.map