Type alias CustomTransformer

Type declaration

• • (this, node, queryOptions?, subResults?): string

  • Type of a custom transformer function.

    Parameters

    • this: {
          _escape: ((v, keepWildCardChars?) => string);
          _super: Record<string, Transformer>;
          _valueToString: ((v) => string);
      }

      The custom this context.

      • _escape: ((v, keepWildCardChars?) => string)

        • • (v, keepWildCardChars?): string

          • A helper utility to escape string values

            Parameters

            • v: any

            • Optional keepWildCardChars: boolean

            Returns string

      • _super: Record<string, Transformer>

        Allows access to default transformers

      • _valueToString: ((v) => string)

        • • (v): string

          • A helper utility to convert a value into a string

            Parameters

            • v: any

            Returns string

    • node: ASTNode

      The current ast node.

    • Optional queryOptions: ComplexQueryToSolrQLOptions

      The used query options.

    • Optional subResults: string[]

      Result of child transformers.

    Returns string

    Transformation result.