Class CompositeClause

The result of multiple clauses concatenated with Cypher.utils.concat

Hierarchy (View Summary)

Clause
- CompositeClause

Index

Accessors

Methods

Accessors

children

get children(): CypherASTNode[]
Returns CypherASTNode[]
Deprecated
Children from a composite clause should not be accessed as this will lead to unexpected behaviour
- Defined in clauses/utils/concat.ts:56

empty

get empty(): boolean
Returns boolean
- Defined in clauses/utils/concat.ts:51

Methods

build

build(
    config?: Partial<
        {
            cypherVersion: "5";
            extraParams: Record<string, unknown>;
            labelOperator: ":" | "&";
            prefix: string;
            unsafeEscapeOptions: Partial<
                {
                    disableNodeLabelEscaping: boolean;
                    disableRelationshipTypeEscaping: boolean;
                },
            >;
        },
    >,
): CypherResult
Compiles a clause into Cypher and params
Parameters
- Optionalconfig: Partial<
      {
          cypherVersion: "5";
          extraParams: Record<string, unknown>;
          labelOperator: ":" | "&";
          prefix: string;
          unsafeEscapeOptions: Partial<
              {
                  disableNodeLabelEscaping: boolean;
                  disableRelationshipTypeEscaping: boolean;
              },
          >;
      },
  >
Returns CypherResult
Inherited from Clause.build
- Defined in clauses/Clause.ts:84

concat

concat(...clauses: (undefined | Clause)[]): this
Parameters
- ...clauses: (undefined | Clause)[]
Returns this
- Defined in clauses/utils/concat.ts:44