ConfigArgs

ConfigArgs

ConfigArgs

A object which defines the configurable arguments which may be passed to functions in those classes which implement the ConfigurableOperationDef interface.

Data types

Each argument has a data type, which must be one of ConfigArgType.

Example

{
  apiKey: { type: 'string' },
  maxRetries: { type: 'int' },
  logErrors: { type: 'boolean' },
}

Lists

Setting the list property to true will make the argument into an array of the specified data type. For example, if you want to store an array of strings:

Example

{
  aliases: {
    type: 'string',
    list: true,
  },
}

In the Admin UI, this will be rendered as an orderable list of string inputs.

UI Component

The ui field allows you to specify a specific input component to be used in the Admin UI. When not set, a default input component is used appropriate to the data type.

Example

{
  operator: {
    type: 'string',
    ui: {
      component: 'select-form-input',
      options: [
        { value: 'startsWith' },
        { value: 'endsWith' },
        { value: 'contains' },
        { value: 'doesNotContain' },
      ],
    },
  },
  secretKey: {
    type: 'string',
    ui: { component: 'password-form-input' },
  },
}

The available components as well as their configuration options can be found in the DefaultFormConfigHash docs. Custom UI components may also be defined via an Admin UI extension using the registerFormInputComponent() function which is exported from @vendure/admin-ui/core.

Signature

type ConfigArgs = {
  [name: string]: ConfigArgDef<ConfigArgType>;
}

Members

[index]

property
type:
ConfigArgDef<ConfigArgType>