Skip to main content

Operations

Overview​

Operations are modular, reusable functions that perform specific tasks within the cogfy-operations system. Each operation is designed to be self-contained with a defined schema and method implementation.

Structure​

An operation consists of two main parts:

  1. Schema - Defines the operation's metadata and interface
  2. Method - Contains the actual implementation logic

Schema Definition​

Each operation's schema includes:

  • displayName - Human readable name for the operation
  • description - Brief explanation of what the operation does
  • inputs - Definition of required and optional input parameters
  • output - Definition of the operation's return type

Example schema:

export const schema = {
  displayName: 'Slugify',
  description: 'Convert a string to a URL-friendly slug',
  inputs: {
    text: {
      displayName: 'Text',
      type: 'text',
      required: true
    }
  },
  output: { type: 'text' }
} as const