Interface RunQuerySQLFilter

Represents a custom SQL filter that can be used in Nunjucks templates for safe SQL query construction in RunQuery operations

interface RunQuerySQLFilter {
    description: string;
    exampleInput: any;
    exampleOutput: string;
    exampleSyntax: string;
    implementation?: ((value) => any);
    name: string;
    notes?: string;
}

Properties

description exampleInput exampleOutput exampleSyntax implementation? name notes?

Properties

description

description: string

Human-readable description of what the filter does

exampleInput

exampleInput: any

Example input value

exampleOutput

exampleOutput: string

Example output after filtering

exampleSyntax

exampleSyntax: string

Example usage showing the filter syntax in a Nunjucks template

Optional implementation

implementation?: ((value) => any)

Optional implementation function for the filter. When provided, this function will be called to apply the filter. This is separate from the definition to keep AI prompts token-efficient.

Type declaration

    • (value): any

    • Parameters

      • value: any

      Returns any

name

name: string

The name of the filter as used in templates (e.g., "sqlString")

Optional notes

notes?: string

Additional notes or warnings about using this filter

Settings

Member Visibility

Theme

On This Page

descriptionexampleInputexampleOutputexampleSyntaximplementationnamenotes