Skip to main content

ConfigurableOperationDefOptions

ConfigurableOperationDefOptions​

@vendure/coreconfigurable-operation.ts

Common configuration options used when creating a new instance of a ConfigurableOperationDef (

Signature
interface ConfigurableOperationDefOptions<T extends ConfigArgs> extends InjectableStrategy {
    code: string;
    args: T;
    description: LocalizedStringArray;
}

code​

property
string

A unique code used to identify this operation.

args​

property
T

Optional provider-specific arguments which, when specified, are editable in the admin-ui. For example, args could be used to store an API key for a payment provider service.

Example

args: {
  apiKey: { type: 'string' },
}

See ConfigArgs for available configuration options.

description​

property
LocalizedStringArray

A human-readable description for the operation method.