clyops Node API
    Preparing search index...

    Interface SchemaOption

    An option as declared by a tool schema.

    interface SchemaOption {
        choices: string[];
        default: string;
        description: string;
        group: string;
        isArray: boolean;
        isFlag: boolean;
        name: string;
        required: boolean;
        secret?: boolean;
        shortName: string;
        type: "string" | "number" | "boolean" | "integer" | "choice" | "path";
        validation: string;
        variableName: string;
    }
    Index
    choices default description group isArray isFlag name required secret? shortName type validation variableName
    choices: string[]

    Accepted values for a choice option.

    default: string

    Declared default as schema text; empty means no default.

    description: string

    Human-readable description shown in help and documentation.

    group: string

    Help section containing this option.

    isArray: boolean

    Whether repeated option values accumulate in an array.

    isFlag: boolean

    Whether the option has flag semantics.

    name: string

    Program, command, option, or argument name as declared in its containing type.

    required: boolean

    Whether an explicit value is required.

    secret?: boolean

    Holds a secret (spec section 1.5); absent in schemas from before 0.2.

    shortName: string

    One-character option alias, or empty when absent.

    type: "string" | "number" | "boolean" | "integer" | "choice" | "path"

    Declared value type or relationship kind, according to the containing interface.

    validation: string

    Validation rule in the shared specification.

    variableName: string

    Option variable name, used for environment lookup and resolved values.

    Settings
    Member Visibility

    On This Page
    Properties