Interface GearInfo

interface GearInfo {
    author: string;
    capabilities?: string[];
    cite?: string;
    command?: string;
    config: GearConfig;
    custom: {
        flywheel?: {
            invalid?: boolean;
            suite?: string;
        };
        [key: string]: any;
    };
    description: string;
    environment?: Record<string, string>;
    flywheel?: Record<string, string>;
    inputs: {
        [name: string]: GearInput;
    };
    label: string;
    license: string;
    maintainer: string;
    name: string;
    source: string;
    url: string;
    version: string;
}

Properties

author capabilities? cite? command? config custom description environment? flywheel? inputs label license maintainer name source url version

Properties

author

author: string

Optional capabilities

capabilities?: string[]

Optional cite

cite?: string

Optional command

command?: string

config

config: GearConfig

custom

custom: {
    flywheel?: {
        invalid?: boolean;
        suite?: string;
    };
    [key: string]: any;
}

Type declaration

  • [key: string]: any
  • Optional flywheel?: {
        invalid?: boolean;
        suite?: string;
    }
    • Optional invalid?: boolean
    • Optional suite?: string

description

description: string

Optional environment

environment?: Record<string, string>

Optional flywheel

flywheel?: Record<string, string>

inputs

inputs: {
    [name: string]: GearInput;
}

Type declaration

label

label: string

license

license: string

maintainer

maintainer: string

name

name: string

source

source: string

url

url: string

version

version: string

Settings

Member Visibility

Theme

On This Page

authorcapabilitiescitecommandconfigcustomdescriptionenvironmentflywheelinputslabellicensemaintainernamesourceurlversion