mirror of
https://github.com/appium/appium.git
synced 2026-02-21 02:39:30 -06:00
8a6a4ba7e7
- appium@2.0.0-rc.5 - @appium/base-driver@9.3.15 - @appium/base-plugin@2.2.15 - @appium/doctor@2.0.21 - @appium/docutils@0.4.4 - @appium/driver-test-support@0.4.10 - @appium/eslint-config-appium@8.0.4 - @appium/fake-driver@5.2.6 - @appium/fake-plugin@3.1.19 - @appium/plugin-test-support@0.3.18 - @appium/schema@0.3.1 - @appium/support@4.1.2 - @appium/test-support@3.0.20 - @appium/types@0.13.2
@appium/schema
JSON schema for Appium configuration files
Description
This package is used internally by Appium, but can also be used to validate Appium configuration files in other contexts.
Install
npm i @appium/schema
Usage
The schema is exported as a JS object:
const { AppiumConfigJsonSchema } = require('@appium/schema');
It is also provided as a JSON file (since this is a JSON schema, after all):
const schema = require('@appium/schema/lib/appium-config.schema.json');
See Also
@appium/types exports a TypeScript type AppiumConfig (generated from this package) for typesafe configuration objects; this may be useful if your Appium configuration is written in JS (e.g., .appiumrc.js). Example:
// @ts-check
/** @type {import('@appium/types').AppiumConfig} */
module.exports = {
server: {
port: 1234,
host: '127.0.0.1'
}
}
Notes
lib/appium-config.schema.json is generated by this package from lib/appium-config-schema.js (the single source of truth), but is under version control to avoid chicken-or-egg build problems.
License
Apache-2.0