@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

Current Tags

• 1.1.0                                ...           latest (a month ago)
• 1.0.0-rc.1                                ...           rc (8 months ago)

31 Versions

• 1.1.0                                ...           a month ago
• 1.0.1                                ...           3 months ago
• 1.0.0                                ...           8 months ago
• 1.0.0-rc.1                                ...           8 months ago
• 0.8.1                                ...           a year ago
• 0.8.0                                ...           a year ago
• 0.7.1                                ...           a year ago
• 0.7.0                                ...           a year ago
• 0.6.1                                ...           2 years ago
• 0.5.0                                ...           2 years ago
• 0.4.2                                ...           2 years ago
• 0.4.1                                ...           2 years ago
• 0.4.0                                ...           2 years ago
• 0.3.1                                ...           3 years ago
• 0.3.0                                ...           3 years ago
• 0.2.6                                ...           3 years ago
• 0.2.5                                ...           3 years ago
• 0.2.4                                ...           3 years ago
• 0.2.3                                ...           3 years ago
• 0.2.2                                ...           3 years ago
• 0.2.0                                ...           3 years ago
• 0.1.0                                ...           3 years ago
• 0.0.9                                ...           4 years ago
• 0.0.8                                ...           4 years ago
• 0.0.7                                ...           4 years ago
• 0.0.6                                ...           4 years ago
• 0.0.5                                ...           4 years ago
• 0.0.4                                ...           4 years ago
• 0.0.3                                ...           4 years ago
• 0.0.2                                ...           4 years ago
• 0.0.1                                ...           4 years ago