Member Junction
    Preparing search index...

    Stores parameter definitions for parameterized queries that use Nunjucks templates. Each parameter represents a dynamic value that can be passed when executing the query. Parameters are automatically extracted from the query template by the MJQueryEntityServer using LLM analysis, or can be manually defined. The combination of parameter metadata and validation filters creates a self-documenting, type-safe query execution system.

    Use MJQueryParameterEntity from @memberjunction/core-entities instead.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    __mj_CreatedAt: Date = null

    Date and time when this parameter was created

    __mj_UpdatedAt: Date = null

    Date and time when this parameter was last updated

    AutoDetectConfidenceScore: number = null

    Confidence score (0.00-1.00) when AI detection was used

    DefaultValue: string = null

    Default value to use when parameter is not provided

    Description: string = null

    Human-readable description of what this parameter is for

    DetectionMethod: "AI" | "Manual" = 'Manual'

    How this parameter was detected: AI (automatic) or Manual (user-specified)

    ID: any = null

    Primary Key

    IsRequired: boolean = false

    Whether this parameter must be provided when executing the query

    Name: string = null

    The name of the parameter as it appears in the Nunjucks template (e.g., {{parameterName}})

    Query: string = null

    Query name from the related query

    QueryID: string = null

    Foreign key to the query this parameter belongs to

    SampleValue: string = null

    Example value demonstrating the proper format for this parameter

    Type: "string" | "number" | "boolean" | "date" | "array" = null

    Data type of the parameter for validation and type casting

    ValidationFilters: string = null

    JSON array of Nunjucks filter definitions for value transformation

    Accessors

    • get ParsedFilters(): any[]

      Gets the parsed validation filters for this parameter. Parses the JSON string of filter definitions into an array of filter objects.

      Returns any[]

      Array of parsed filter definitions, or empty array if parsing fails

    Methods

    • Copies initialization data from a plain object to the class instance. Only copies properties that already exist on the class to prevent creating new fields. Special handling for DefaultValue fields to extract actual values from SQL Server syntax.

      Parameters

      • initData: any

        The initialization data object

      Returns void

    • Default JSON serialization for BaseInfo subclasses.

      Emits all non-underscored direct field declarations. For _-prefixed private backing fields (the MJ pattern for collection storage — e.g. _Fields, _RelatedEntities, _OrganicKeys), emits the value of the corresponding same-named public getter instead. Purely computed getters without a backing field (display-name formatters, derived flags) are intentionally skipped — they can throw when source fields are null and don't belong on the wire anyway.

      Nested BaseInfo instances and arrays of them unwrap automatically via JSON.stringify's native toJSON() protocol.

      Subclasses may override to emit a filtered subset or custom shape (see EntityFieldValueInfo).

      Returns Record<string, unknown>