@appium/types/lib/constraints.ts

Various type declarations used across Appium

import type {Constraints} from './driver';

export const BASE_DESIRED_CAP_CONSTRAINTS = {
  platformName: {
    presence: true,
    isString: true,
  },
  app: {
    isString: true,
  },
  platformVersion: {
    isString: true,
  },
  webSocketUrl: {
    isBoolean: true,
  },
  newCommandTimeout: {
    isNumber: true,
  },
  automationName: {
    isString: true,
  },
  autoLaunch: {
    isBoolean: true,
  },
  udid: {
    isString: true,
  },
  orientation: {
    inclusion: ['LANDSCAPE', 'PORTRAIT'],
  },
  autoWebview: {
    isBoolean: true,
  },
  noReset: {
    isBoolean: true,
  },
  fullReset: {
    isBoolean: true,
  },
  language: {
    isString: true,
  },
  locale: {
    isString: true,
  },
  eventTimings: {
    isBoolean: true,
  },
  printPageSourceOnFindFailure: {
    isBoolean: true,
  },
} as const satisfies Constraints;

export type BaseDriverCapConstraints = typeof BASE_DESIRED_CAP_CONSTRAINTS;