@neo4j/cypher-builder/dist/namespaces/apoc/date.js

A programmatic API for building Cypher queries for Neo4j

"use strict";
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.convertFormat = convertFormat;
const CypherFunctions_1 = require("../../expressions/functions/CypherFunctions");
const string_1 = require("../../expressions/functions/string");
const Literal_1 = require("../../references/Literal");
/**
 * @group Functions
 * @see [Apoc Documentation](https://neo4j.com/docs/apoc/current/overview/apoc.date/apoc.date.convertFormat/)
 * @deprecated apoc methods will no longer be supported in Cypher Builder version 3
 * @example
 * ```ts
 * Cypher.apoc.date.convertFormat(
 *  new Cypher.Param("2020-11-04"),
 *  "date",
 *  "basic_date"
 * )
 *```
 */
function convertFormat(temporalParam, currentFormat, convertTo = "yyyy-MM-dd") {
    return new CypherFunctions_1.CypherFunction("apoc.date.convertFormat", [
        (0, string_1.toString)(temporalParam), // NOTE: should this be `toString` by default?
        new Literal_1.Literal(currentFormat),
        new Literal_1.Literal(convertTo),
    ]);
}