Codify
Plugin Development

Parameter settings

Configure parameter behavior

Parameter Settings

Configure parameter behavior:

parameterSettings: {
  // Modifiable parameter
  version: {
    canModify: true
  },

  // Directory path with transformation
  path: {
    type: 'directory',
    inputTransformation: {
      to: (input) => untildify(input),     // Expand ~
      from: (current) => tildify(current)  // Convert to ~
    }
  },

  // Sensitive parameter (hidden in output)
  apiKey: {
    isSensitive: true
  },

  // Array parameter with custom equality
  tags: {
    type: 'array',
    isElementEqual: (a, b) => a.name === b.name,
    filterInStatelessMode: (desired, current) =>
      current.filter(c => desired.some(d => d.name === c.name))
  },

  // Boolean setting (not tracked in state)
  skipCache: {
    type: 'boolean',
    default: true,
    setting: true
  }
}

On this page