diff --git a/DEVELOPING.md b/DEVELOPING.md index 5214dcdd..3c5970e2 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -26,7 +26,7 @@ The comments should follow these conventions: - Brief description - @group - This should be the Cypher concept related to this interface. Cypher Functions, Clauses, Operators, Procedures, Other Expressions. -- @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual) - A link to the element in the Cypher documentation +- @see {@link https://neo4j.com/docs/cypher-manual | Cypher Documentation} - A link to the element in the Cypher documentation - @internal - If used by the library and not exposed - @example - example of usage and resulting Cypher diff --git a/src/clauses/Call.ts b/src/clauses/Call.ts index 8ec3815d..b04de782 100644 --- a/src/clauses/Call.ts +++ b/src/clauses/Call.ts @@ -55,7 +55,7 @@ type InTransactionConfig = { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/ | Cypher Documentation} * @category Clauses */ @mixin(WithReturn, WithWith, WithUnwind, WithDelete, WithSetRemove, WithMatch, WithCreate, WithMerge, WithOrder) @@ -75,7 +75,7 @@ export class Call extends Clause { } /** Adds a `WITH` statement inside `CALL {`, this `WITH` can is used to import variables outside of the subquery - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#call-importing-variables) + * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#call-importing-variables | Cypher Documentation} */ public importWith(...params: Array): this { if (this._importWith) { @@ -97,7 +97,7 @@ export class Call extends Clause { } /** Makes the subquery an OPTIONAL CALL - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call) + * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation} * @version Neo4j 5.24 */ public optional(): this { @@ -179,7 +179,7 @@ export class Call extends Clause { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call) + * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/#optional-call | Cypher Documentation} * @category Clauses */ export class OptionalCall extends Call { diff --git a/src/clauses/Create.ts b/src/clauses/Create.ts index d59a1d9a..2df2cbf4 100644 --- a/src/clauses/Create.ts +++ b/src/clauses/Create.ts @@ -34,7 +34,7 @@ import { mixin } from "./utils/mixin"; export interface Create extends WithReturn, WithSetRemove, WithWith, WithDelete, WithMerge, WithFinish, WithOrder {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation} * @category Clauses */ @mixin(WithReturn, WithSetRemove, WithWith, WithDelete, WithMerge, WithFinish, WithOrder) @@ -51,7 +51,7 @@ export class Create extends Clause { } /** Add a {@link Create} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation} */ public create(clauseOrPattern: Create | Pattern): Create { if (clauseOrPattern instanceof Create) { diff --git a/src/clauses/Finish.ts b/src/clauses/Finish.ts index df9fb2db..99c3ff63 100644 --- a/src/clauses/Finish.ts +++ b/src/clauses/Finish.ts @@ -20,7 +20,7 @@ import { Clause } from "./Clause"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/finish/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/finish/ | Cypher Documentation} * @category Clauses */ export class Finish extends Clause { diff --git a/src/clauses/Foreach.ts b/src/clauses/Foreach.ts index d8c982d5..5916692f 100644 --- a/src/clauses/Foreach.ts +++ b/src/clauses/Foreach.ts @@ -41,7 +41,7 @@ export interface Foreach extends WithWith, WithReturn, WithSetRemove, WithDelete type ForeachClauses = Foreach | SetClause | RemoveClause | Create | Merge | DeleteClause; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/foreach/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/foreach/ | Cypher Documentation} * @category Clauses */ @mixin(WithWith, WithReturn, WithSetRemove, WithDelete, WithCreate, WithMerge) diff --git a/src/clauses/LoadCSV.ts b/src/clauses/LoadCSV.ts index 3470d8ce..32ac0b0b 100644 --- a/src/clauses/LoadCSV.ts +++ b/src/clauses/LoadCSV.ts @@ -31,7 +31,7 @@ import { mixin } from "./utils/mixin"; export interface LoadCSV extends WithReturn, WithCreate, WithMerge, WithWith, WithWhere, WithCallProcedure {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/ | Cypher Documentation} * @category Clauses */ @mixin(WithReturn, WithCreate, WithMerge, WithWith, WithWhere, WithCallProcedure) diff --git a/src/clauses/Match.ts b/src/clauses/Match.ts index 52911760..9d0abb63 100644 --- a/src/clauses/Match.ts +++ b/src/clauses/Match.ts @@ -57,7 +57,7 @@ type ShortestStatement = { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation} * @category Clauses */ @mixin( @@ -85,7 +85,7 @@ export class Match extends Clause { } /** Makes the clause an OPTIONAL MATCH - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation} * @example * ```ts * new Cypher.Match(new Node({labels: ["Movie"]})).optional(); @@ -101,7 +101,7 @@ export class Match extends Clause { } /** Add a {@link Match} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation} */ public match(clauseOrPattern: Match | Pattern): Match { if (clauseOrPattern instanceof Match) { @@ -116,7 +116,7 @@ export class Match extends Clause { } /** Add an {@link OptionalMatch} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation} */ public optionalMatch(pattern: Pattern): OptionalMatch { const matchClause = new OptionalMatch(pattern); @@ -186,7 +186,7 @@ export class Match extends Clause { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation} * @category Clauses */ export class OptionalMatch extends Match { diff --git a/src/clauses/Merge.ts b/src/clauses/Merge.ts index d9c570dd..1eb22c94 100644 --- a/src/clauses/Merge.ts +++ b/src/clauses/Merge.ts @@ -37,7 +37,7 @@ import { mixin } from "./utils/mixin"; export interface Merge extends WithReturn, WithSetRemove, WithDelete, WithWith, WithCreate, WithFinish, WithOrder {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation} * @category Clauses */ @mixin(WithReturn, WithSetRemove, WithDelete, WithWith, WithCreate, WithFinish, WithOrder) @@ -65,7 +65,7 @@ export class Merge extends Clause { } /** Add a {@link Merge} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation} */ public merge(clauseOrPattern: Merge | Pattern): Merge { if (clauseOrPattern instanceof Merge) { diff --git a/src/clauses/Return.ts b/src/clauses/Return.ts index 7f8f02bd..8aa1afe6 100644 --- a/src/clauses/Return.ts +++ b/src/clauses/Return.ts @@ -29,7 +29,7 @@ import { mixin } from "./utils/mixin"; export interface Return extends WithOrder {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/return/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/return/ | Cypher Documentation} * @category Clauses */ @mixin(WithOrder) diff --git a/src/clauses/Union.ts b/src/clauses/Union.ts index 3779dbc3..6297fc06 100644 --- a/src/clauses/Union.ts +++ b/src/clauses/Union.ts @@ -22,7 +22,7 @@ import type { CypherEnvironment } from "../Environment"; import { Clause } from "./Clause"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/union/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/union/ | Cypher Documentation} * @category Clauses */ export class Union extends Clause { diff --git a/src/clauses/Unwind.ts b/src/clauses/Unwind.ts index 1d72b44b..c8e57c37 100644 --- a/src/clauses/Unwind.ts +++ b/src/clauses/Unwind.ts @@ -46,7 +46,7 @@ export interface Unwind export type UnwindProjectionColumn = [Expr, string | Variable | Literal]; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation} * @category Clauses */ @mixin(WithWith, WithDelete, WithMatch, WithReturn, WithSetRemove, WithCreate, WithMerge, WithOrder) @@ -60,7 +60,7 @@ export class Unwind extends Clause { // Cannot be part of WithUnwind due to dependency cycles /** Append an {@link Unwind} clause. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation} */ public unwind(clause: Unwind): Unwind; public unwind(projection: UnwindProjectionColumn): Unwind; diff --git a/src/clauses/Use.ts b/src/clauses/Use.ts index 6b1c4e8f..4dd513bb 100644 --- a/src/clauses/Use.ts +++ b/src/clauses/Use.ts @@ -22,7 +22,7 @@ import type { CypherEnvironment } from "../Environment"; import { Clause } from "./Clause"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/5/clauses/use/) + * @see {@link https://neo4j.com/docs/cypher-manual/5/clauses/use/ | Cypher Documentation} * @category Clauses */ export class Use extends Clause { diff --git a/src/clauses/With.ts b/src/clauses/With.ts index 8d72cfbb..346691bb 100644 --- a/src/clauses/With.ts +++ b/src/clauses/With.ts @@ -52,7 +52,7 @@ export interface With WithCall {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation} * @category Clauses */ @mixin( @@ -89,7 +89,7 @@ export class With extends Clause { // Cannot be part of WithWith due to dependency cycles /** Add a {@link With} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation} */ public with(clause: With): With; public with(...columns: Array<"*" | WithProjection>): With; diff --git a/src/clauses/mixins/clauses/WithCall.ts b/src/clauses/mixins/clauses/WithCall.ts index 75fa30be..d7718721 100644 --- a/src/clauses/mixins/clauses/WithCall.ts +++ b/src/clauses/mixins/clauses/WithCall.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithCall extends MixinClause { /** Add a {@link Call} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/call-subquery/ | Cypher Documentation} */ public call(subquery: Clause, variableScope?: Variable[] | "*"): Call { const callClause = new Call(subquery, variableScope); diff --git a/src/clauses/mixins/clauses/WithCallProcedure.ts b/src/clauses/mixins/clauses/WithCallProcedure.ts index 443b7303..9c45b2d0 100644 --- a/src/clauses/mixins/clauses/WithCallProcedure.ts +++ b/src/clauses/mixins/clauses/WithCallProcedure.ts @@ -22,7 +22,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithCallProcedure extends MixinClause { /** Add a call {@link Procedure} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call/ | Cypher Documentation} */ public callProcedure(procedure: T): T { this.addNextClause(procedure); diff --git a/src/clauses/mixins/clauses/WithCreate.ts b/src/clauses/mixins/clauses/WithCreate.ts index 339bc6e5..83fb7de2 100644 --- a/src/clauses/mixins/clauses/WithCreate.ts +++ b/src/clauses/mixins/clauses/WithCreate.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithCreate extends MixinClause { /** Add a {@link Create} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/create/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/create/ | Cypher Documentation} */ public create(clauseOrPattern: Create | Pattern): Create { diff --git a/src/clauses/mixins/clauses/WithFinish.ts b/src/clauses/mixins/clauses/WithFinish.ts index 565d6196..6374a379 100644 --- a/src/clauses/mixins/clauses/WithFinish.ts +++ b/src/clauses/mixins/clauses/WithFinish.ts @@ -22,7 +22,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithFinish extends MixinClause { /** Append a {@link Finish} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/finish/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/finish/ | Cypher Documentation} */ public finish(): Finish { const finishClause = new Finish(); diff --git a/src/clauses/mixins/clauses/WithMatch.ts b/src/clauses/mixins/clauses/WithMatch.ts index 007ba929..2f2d9480 100644 --- a/src/clauses/mixins/clauses/WithMatch.ts +++ b/src/clauses/mixins/clauses/WithMatch.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithMatch extends MixinClause { /** Add a {@link Match} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/match/ | Cypher Documentation} */ public match(clauseOrPattern: Match | Pattern): Match { @@ -39,7 +39,7 @@ export abstract class WithMatch extends MixinClause { } /** Add an {@link OptionalMatch} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/optional-match/ | Cypher Documentation} */ public optionalMatch(pattern: Pattern): OptionalMatch { diff --git a/src/clauses/mixins/clauses/WithMerge.ts b/src/clauses/mixins/clauses/WithMerge.ts index 1cb1c769..b7f85492 100644 --- a/src/clauses/mixins/clauses/WithMerge.ts +++ b/src/clauses/mixins/clauses/WithMerge.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithMerge extends MixinClause { /** Add a {@link Merge} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/merge/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/merge/ | Cypher Documentation} */ public merge(clauseOrPattern: Merge | Pattern): Merge { diff --git a/src/clauses/mixins/clauses/WithReturn.ts b/src/clauses/mixins/clauses/WithReturn.ts index ae02aedf..ad7b1c4b 100644 --- a/src/clauses/mixins/clauses/WithReturn.ts +++ b/src/clauses/mixins/clauses/WithReturn.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithReturn extends MixinClause { /** Append a {@link Return} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/return/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/return/ | Cypher Documentation} */ public return(clause: Return): Return; public return(...columns: Array<"*" | ProjectionColumn>): Return; diff --git a/src/clauses/mixins/clauses/WithUnwind.ts b/src/clauses/mixins/clauses/WithUnwind.ts index 806ce8d3..72d09b21 100644 --- a/src/clauses/mixins/clauses/WithUnwind.ts +++ b/src/clauses/mixins/clauses/WithUnwind.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithUnwind extends MixinClause { /** Append an {@link Unwind} clause. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/unwind/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/unwind/ | Cypher Documentation} */ public unwind(clause: Unwind): Unwind; public unwind(projection: UnwindProjectionColumn): Unwind; diff --git a/src/clauses/mixins/clauses/WithWith.ts b/src/clauses/mixins/clauses/WithWith.ts index 20c5de38..d1469949 100644 --- a/src/clauses/mixins/clauses/WithWith.ts +++ b/src/clauses/mixins/clauses/WithWith.ts @@ -23,7 +23,7 @@ import { MixinClause } from "../Mixin"; export abstract class WithWith extends MixinClause { /** Add a {@link With} clause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/with/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation} */ public with(clause: With): With; public with(...columns: Array<"*" | WithProjection>): With; diff --git a/src/clauses/mixins/sub-clauses/WithDelete.ts b/src/clauses/mixins/sub-clauses/WithDelete.ts index b9ada6c0..2ae19451 100644 --- a/src/clauses/mixins/sub-clauses/WithDelete.ts +++ b/src/clauses/mixins/sub-clauses/WithDelete.ts @@ -25,7 +25,7 @@ export abstract class WithDelete extends Mixin { protected deleteClause: DeleteClause | undefined; /** Add a `DELETE` subclause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/ | Cypher Documentation} */ public delete(...deleteInput: DeleteInput): this { this.createDeleteClause(deleteInput); @@ -33,7 +33,7 @@ export abstract class WithDelete extends Mixin { } /** Adds a `DETACH DELETE` subclause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/ | Cypher Documentation} */ public detachDelete(...deleteInput: DeleteInput): this { const deleteClause = this.createDeleteClause(deleteInput); @@ -42,7 +42,7 @@ export abstract class WithDelete extends Mixin { } /** Add a `NODETACH DELETE` subclause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/delete/#delete-nodetach) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/delete/#delete-nodetach | Cypher Documentation} * @version Neo4j 5.14 */ public noDetachDelete(...deleteInput: DeleteInput): this { diff --git a/src/clauses/mixins/sub-clauses/WithOrder.ts b/src/clauses/mixins/sub-clauses/WithOrder.ts index 6072d109..0b8fab58 100644 --- a/src/clauses/mixins/sub-clauses/WithOrder.ts +++ b/src/clauses/mixins/sub-clauses/WithOrder.ts @@ -28,7 +28,7 @@ export abstract class WithOrder extends Mixin { protected orderByStatement: OrderBy | undefined; /** Add an `ORDER BY` subclause. Note that `ASC` is the default sorting order - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/order-by/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/order-by/ | Cypher Documentation} */ public orderBy(...exprs: Array<[Expr, Order] | Expr | [Expr]>): this { const normalizedExprs = exprs.map((rawExpr): [Expr, Order] => { @@ -45,7 +45,7 @@ export abstract class WithOrder extends Mixin { } /** Add a `SKIP` subclause. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/skip/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/skip/ | Cypher Documentation} */ public skip(value: number | Expr): this { const orderByStatement = this.getOrCreateOrderBy(); @@ -54,7 +54,7 @@ export abstract class WithOrder extends Mixin { } /** Add a `OFFSET` subclause. An alias to `SKIP` - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/skip/#offset-synonym) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/skip/#offset-synonym | Cypher Documentation} * @version Neo4j 5.24 */ public offset(value: number | Expr): this { @@ -64,7 +64,7 @@ export abstract class WithOrder extends Mixin { } /** Add a `LIMIT` subclause. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/limit/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/limit/ | Cypher Documentation} */ public limit(value: number | Expr): this { const orderByStatement = this.getOrCreateOrderBy(); diff --git a/src/clauses/mixins/sub-clauses/WithSetRemove.ts b/src/clauses/mixins/sub-clauses/WithSetRemove.ts index ed2cefd9..94f4655b 100644 --- a/src/clauses/mixins/sub-clauses/WithSetRemove.ts +++ b/src/clauses/mixins/sub-clauses/WithSetRemove.ts @@ -30,7 +30,7 @@ export abstract class WithSetRemove extends Mixin { private subClauses: Array | undefined; /** Append a `SET` clause. Allowing to assign variable properties to values. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/set/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/set/ | Cypher Documentation} */ public set(...params: SetParam[]): this { if (!this.subClauses) { @@ -47,7 +47,7 @@ export abstract class WithSetRemove extends Mixin { } /** Append a `REMOVE` clause. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/remove/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/remove/ | Cypher Documentation} */ public remove(...properties: Array): this { if (!this.subClauses) { diff --git a/src/clauses/mixins/sub-clauses/WithWhere.ts b/src/clauses/mixins/sub-clauses/WithWhere.ts index dbd7e715..884a6feb 100644 --- a/src/clauses/mixins/sub-clauses/WithWhere.ts +++ b/src/clauses/mixins/sub-clauses/WithWhere.ts @@ -34,7 +34,7 @@ export abstract class WithWhere extends Mixin { protected whereSubClause: Where | undefined; /** Add a `WHERE` subclause - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/where/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/where/ | Cypher Documentation} */ public where(input: Predicate | undefined): this; public where(target: Variable | PropertyRef, params: Record): this; diff --git a/src/expressions/Case.ts b/src/expressions/Case.ts index 090a42d5..5b45512d 100644 --- a/src/expressions/Case.ts +++ b/src/expressions/Case.ts @@ -24,7 +24,7 @@ import { compileCypherIfExists } from "../utils/compile-cypher-if-exists"; import { padBlock } from "../utils/pad-block"; /** Case statement - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#query-syntax-case) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#query-syntax-case | Cypher Documentation} * @group Other */ export class Case extends CypherASTNode { diff --git a/src/expressions/HasLabel.ts b/src/expressions/HasLabel.ts index 79664e93..e50c1d5c 100644 --- a/src/expressions/HasLabel.ts +++ b/src/expressions/HasLabel.ts @@ -26,7 +26,7 @@ import { addLabelToken } from "../utils/add-label-token"; import { escapeLabel } from "../utils/escape"; /** Generates a predicate to check if a node has a label or a relationship has a type - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/where/#filter-on-node-label) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/where/#filter-on-node-label | Cypher Documentation} * @group Other * @example * ```cypher diff --git a/src/expressions/IsType.ts b/src/expressions/IsType.ts index 46a3e987..c83ac070 100644 --- a/src/expressions/IsType.ts +++ b/src/expressions/IsType.ts @@ -62,7 +62,7 @@ function list(type: Type | Type[]): ListType { /** * Types supported by Neo4j - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/values-and-types/property-structural-constructed/#types-synonyms) + * @see {@link https://neo4j.com/docs/cypher-manual/current/values-and-types/property-structural-constructed/#types-synonyms | Cypher Documentation} */ export const CypherTypes = { ...BaseTypes, @@ -71,7 +71,7 @@ export const CypherTypes = { /** * Type predicate expression - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/values-and-types/type-predicate/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/values-and-types/type-predicate/ | Cypher Documentation} * @example * ```cypher * val IS :: INTEGER @@ -83,7 +83,7 @@ export function isType(expr: Expr, type: Type | Type[]): IsType { /** * Type predicate expression with NOT - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/values-and-types/type-predicate/#type-predicate-not) + * @see {@link https://neo4j.com/docs/cypher-manual/current/values-and-types/type-predicate/#type-predicate-not | Cypher Documentation} * @example * ```cypher * val IS NOT :: INTEGER diff --git a/src/expressions/functions/CypherFunctions.ts b/src/expressions/functions/CypherFunctions.ts index 6bbfe9ac..961ec9c0 100644 --- a/src/expressions/functions/CypherFunctions.ts +++ b/src/expressions/functions/CypherFunctions.ts @@ -22,7 +22,7 @@ import type { CypherEnvironment } from "../../Environment"; import type { Expr } from "../../types"; /** Represents a Cypher Function, all Cypher functions provided by the library extend from this class, and it can be used to use custom functions - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/ | Cypher Documentation} * @group Cypher Functions * @example * ```ts diff --git a/src/expressions/functions/aggregation.ts b/src/expressions/functions/aggregation.ts index fa23c2ce..127ffdd0 100644 --- a/src/expressions/functions/aggregation.ts +++ b/src/expressions/functions/aggregation.ts @@ -23,7 +23,7 @@ import { normalizeExpr } from "../../utils/normalize-variable"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-count) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-count | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -32,7 +32,7 @@ export function count(expr: Expr | "*"): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-min) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-min | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -41,7 +41,7 @@ export function min(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-max) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-max | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -50,7 +50,7 @@ export function max(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-avg) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-avg | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -59,7 +59,7 @@ export function avg(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-sum) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-sum | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -68,7 +68,7 @@ export function sum(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-collect) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-collect | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -77,7 +77,7 @@ export function collect(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-percentilecont) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-percentilecont | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -87,7 +87,7 @@ export function percentileCont(expr: Expr, percentile: number | Expr): CypherAgg } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-percentiledisc) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-percentiledisc | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -97,7 +97,7 @@ export function percentileDisc(expr: Expr, percentile: number | Expr): CypherAgg } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-stdev) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-stdev | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -106,7 +106,7 @@ export function stDev(expr: Expr): CypherAggregationFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-stdevp) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#functions-stdevp | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -115,7 +115,7 @@ export function stDevP(expr: Expr): CypherAggregationFunction { } /** Represents a Cypher Aggregation function - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating | Cypher Documentation} * @group Cypher Functions * @category Aggregations */ @@ -140,7 +140,7 @@ export class CypherAggregationFunction extends CypherFunction { /** * Adds DISTINCT to remove duplicates on the aggregation functions - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#_counting_with_and_without_duplicates) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/aggregating/#_counting_with_and_without_duplicates | Cypher Documentation} */ public distinct(): this { if (this.hasStar) { diff --git a/src/expressions/functions/graph.ts b/src/expressions/functions/graph.ts index 72dd83a7..9989bd0e 100644 --- a/src/expressions/functions/graph.ts +++ b/src/expressions/functions/graph.ts @@ -21,7 +21,7 @@ import type { Expr } from "../../types"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-names) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-names | Cypher Documentation} * @group Cypher Functions * @category Graph */ @@ -29,7 +29,7 @@ export function names(): CypherFunction { return new CypherFunction("graph.names"); } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-propertiesByName) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-propertiesByName | Cypher Documentation} * @group Cypher Functions * @category Graph */ @@ -37,7 +37,7 @@ export function propertiesByName(name: Expr): CypherFunction { return new CypherFunction("graph.propertiesByName", [name]); } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-byname) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/graph/#functions-graph-byname | Cypher Documentation} * @group Cypher Functions * @category Graph */ diff --git a/src/expressions/functions/list.ts b/src/expressions/functions/list.ts index 18de47d7..c7e35d3b 100644 --- a/src/expressions/functions/list.ts +++ b/src/expressions/functions/list.ts @@ -25,7 +25,7 @@ import { normalizeExpr } from "../../utils/normalize-variable"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-keys) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-keys | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -34,7 +34,7 @@ export function keys(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-labels) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-labels | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -43,7 +43,7 @@ export function labels(nodeRef: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-range) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-range | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -53,7 +53,7 @@ export function range(start: Expr | number, end: Expr | number, step?: Expr | nu } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-reverse-list) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-reverse-list | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -62,7 +62,7 @@ export function reverse(list: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tail) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tail | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -71,7 +71,7 @@ export function tail(list: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tobooleanlist) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tobooleanlist | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -80,7 +80,7 @@ export function toBooleanList(list: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tofloatlist) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tofloatlist | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -89,7 +89,7 @@ export function toFloatList(list: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tointegerlist) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tointegerlist | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -98,7 +98,7 @@ export function toIntegerList(list: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tostringlist) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-tostringlist | Cypher Documentation} * @group Cypher Functions * @category List */ @@ -107,7 +107,7 @@ export function toStringList(list: Expr): CypherFunction { } /** Reduce a list by executing given expression. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-reduce) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/list/#functions-reduce | Cypher Documentation} * @group Cypher Functions * @category List * @example diff --git a/src/expressions/functions/load-csv.ts b/src/expressions/functions/load-csv.ts index d14a9976..6de154fa 100644 --- a/src/expressions/functions/load-csv.ts +++ b/src/expressions/functions/load-csv.ts @@ -20,7 +20,7 @@ import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/#_access_line_numbers_with_linenumber) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/#_access_line_numbers_with_linenumber | Cypher Documentation} * @group Cypher Functions */ export function linenumber(): CypherFunction { @@ -28,7 +28,7 @@ export function linenumber(): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/#_access_the_csv_file_path_with_file) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/#_access_the_csv_file_path_with_file | Cypher Documentation} * @group Cypher Functions */ export function file(): CypherFunction { diff --git a/src/expressions/functions/math.ts b/src/expressions/functions/math.ts index f0d3aca4..6fd4e63a 100644 --- a/src/expressions/functions/math.ts +++ b/src/expressions/functions/math.ts @@ -23,7 +23,7 @@ import { filterTruthy } from "../../utils/filter-truthy"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-abs) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-abs | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -32,7 +32,7 @@ export function abs(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-ceil) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-ceil | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -41,7 +41,7 @@ export function ceil(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-floor) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-floor | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -50,7 +50,7 @@ export function floor(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-isnan) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-isnan | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -59,7 +59,7 @@ export function cypherIsNaN(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-rand) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-rand | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -69,13 +69,13 @@ export function rand(): CypherFunction { /** * Precision mode for `Cypher.round()` - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-round3) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-round3 | Cypher Documentation} * @see {@link round} */ export type ROUND_PRECISION_MODE = "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-round) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-round | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -93,7 +93,7 @@ export function round(expr: Expr, precision?: Expr | number, mode?: ROUND_PRECIS } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-sign) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-numeric/#functions-sign | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -102,7 +102,7 @@ export function sign(expr: Expr): CypherFunction { } /** Cypher function `e()` that returns the returns the base of the natural logarithm. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-e) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-e | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -111,7 +111,7 @@ export function e(): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-exp) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-exp | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -120,7 +120,7 @@ export function exp(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-log) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-log | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -129,7 +129,7 @@ export function log(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-log10) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-log10 | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -138,7 +138,7 @@ export function log10(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-sqrt) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-logarithmic/#functions-sqrt | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -147,7 +147,7 @@ export function sqrt(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-acos) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-acos | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -156,7 +156,7 @@ export function acos(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-asin) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-asin | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -165,7 +165,7 @@ export function asin(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-atan) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-atan | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -174,7 +174,7 @@ export function atan(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-atan2) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-atan2 | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -183,7 +183,7 @@ export function atan2(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-cos) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-cos | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -192,7 +192,7 @@ export function cos(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-cot) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-cot | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -201,7 +201,7 @@ export function cot(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-degrees) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-degrees | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -210,7 +210,7 @@ export function degrees(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-haversin) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-haversin | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -219,7 +219,7 @@ export function haversin(expr: Expr): CypherFunction { } /** 3.141592653589793 - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-pi) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-pi | Cypher Documentation} * @see https://www.piday.org/ * @group Cypher Functions * @category Math @@ -229,7 +229,7 @@ export function pi(): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-radians) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-radians | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -238,7 +238,7 @@ export function radians(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-sin) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-sin | Cypher Documentation} * @group Cypher Functions * @category Math */ @@ -247,7 +247,7 @@ export function sin(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-tan) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/mathematical-trigonometric/#functions-tan | Cypher Documentation} * @group Cypher Functions * @category Math */ diff --git a/src/expressions/functions/path.ts b/src/expressions/functions/path.ts index 8dd48ae1..a526c75b 100644 --- a/src/expressions/functions/path.ts +++ b/src/expressions/functions/path.ts @@ -21,7 +21,7 @@ import type { PathVariable } from "../.."; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-cheat-sheet/current/#_path_functions) + * @see {@link https://neo4j.com/docs/cypher-cheat-sheet/current/#_path_functions | Cypher Documentation} * @group Cypher Functions * @category Path */ @@ -30,7 +30,7 @@ export function nodes(path: PathVariable): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-cheat-sheet/current/#_path_functions) + * @see {@link https://neo4j.com/docs/cypher-cheat-sheet/current/#_path_functions | Cypher Documentation} * @group Cypher Functions * @category Path */ diff --git a/src/expressions/functions/predicate.ts b/src/expressions/functions/predicate.ts index 1f660568..1f24f3fe 100644 --- a/src/expressions/functions/predicate.ts +++ b/src/expressions/functions/predicate.ts @@ -17,23 +17,23 @@ * limitations under the License. */ +import { Where } from "../../clauses/sub-clauses/Where"; import type { CypherEnvironment } from "../../Environment"; import type { Pattern } from "../../pattern/Pattern"; -import { Where } from "../../clauses/sub-clauses/Where"; +import type { Variable } from "../../references/Variable"; import type { Expr, Predicate } from "../../types"; import { compileCypherIfExists } from "../../utils/compile-cypher-if-exists"; -import type { Variable } from "../../references/Variable"; import { CypherFunction } from "./CypherFunctions"; /** Represents a predicate function that can be used in a WHERE statement - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/ | Cypher Documentation} * @group Cypher Functions * @category Predicate */ export class PredicateFunction extends CypherFunction {} /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-all) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-all | Cypher Documentation} * @group Cypher Functions * @category Predicate */ @@ -42,7 +42,7 @@ export function all(variable: Variable, listExpr: Expr, whereFilter: Predicate): } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-any) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-any | Cypher Documentation} * @group Cypher Functions * @category Predicate */ @@ -51,7 +51,7 @@ export function any(variable: Variable, listExpr: Expr, whereFilter: Predicate): } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-exists) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-exists | Cypher Documentation} * @group Cypher Functions * @category Predicate */ @@ -60,7 +60,7 @@ export function exists(pattern: Pattern): PredicateFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-isempty) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-isempty | Cypher Documentation} * @group Cypher Functions * @category Predicate */ @@ -69,7 +69,7 @@ export function isEmpty(list: Expr): PredicateFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-none) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-none | Cypher Documentation} * @group Cypher Functions * @category Predicate */ @@ -78,7 +78,7 @@ export function none(variable: Variable, listExpr: Expr, whereFilter: Predicate) } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-single) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/predicate/#functions-single | Cypher Documentation} * @group Cypher Functions * @category Predicate */ diff --git a/src/expressions/functions/scalar.ts b/src/expressions/functions/scalar.ts index f97e57f5..36fb6271 100644 --- a/src/expressions/functions/scalar.ts +++ b/src/expressions/functions/scalar.ts @@ -22,7 +22,7 @@ import type { Expr } from "../../types"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-coalesce) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-coalesce | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -31,7 +31,7 @@ export function coalesce(expr: Expr, ...optionalExpr: Expr[]): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-elementid) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-elementid | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -40,7 +40,7 @@ export function elementId(variable: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-endnode) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-endnode | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -49,7 +49,7 @@ export function endNode(relationship: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-head) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-head | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -58,7 +58,7 @@ export function head(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-id) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-id | Cypher Documentation} * @group Cypher Functions * @category Scalar * @deprecated Use {@link elementId} instead @@ -68,7 +68,7 @@ export function id(variable: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-last) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-last | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -77,7 +77,7 @@ export function last(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-length) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-length | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -86,7 +86,7 @@ export function length(path: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-properties) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-properties | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -95,7 +95,7 @@ export function properties(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-randomuuid) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-randomuuid | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -104,7 +104,7 @@ export function randomUUID(): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-size) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-size | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -122,7 +122,7 @@ export function size(expr: Expr | Pattern): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-startnode) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-startnode | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -131,7 +131,7 @@ export function startNode(relationship: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-timestamp) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-timestamp | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -140,7 +140,7 @@ export function timestamp(): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-toboolean) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-toboolean | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -149,7 +149,7 @@ export function toBoolean(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tobooleanornull) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tobooleanornull | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -158,7 +158,7 @@ export function toBooleanOrNull(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tofloat) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tofloat | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -167,7 +167,7 @@ export function toFloat(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tofloatornull) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tofloatornull | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -176,7 +176,7 @@ export function toFloatOrNull(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tointeger) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tointeger | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -185,7 +185,7 @@ export function toInteger(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tointegerornull) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-tointegerornull | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -194,7 +194,7 @@ export function toIntegerOrNull(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-type) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-type | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -203,7 +203,7 @@ export function type(relationship: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-valueType) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-valueType | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -212,7 +212,7 @@ export function valueType(expr: Expr): CypherFunction { } /** Alias of size() - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-char_length) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-char_length | Cypher Documentation} * @group Cypher Functions * @category Scalar */ @@ -221,7 +221,7 @@ export function char_length(expr: Expr): CypherFunction { } /** Alias of size() - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-character_length) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-character_length | Cypher Documentation} * @group Cypher Functions * @category Scalar * @version Neo4j 5.13 @@ -231,7 +231,7 @@ export function character_length(expr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-nullIf) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/scalar/#functions-nullIf | Cypher Documentation} * @group Cypher Functions * @category Scalar * @version Neo4j 5.14 diff --git a/src/expressions/functions/spatial.ts b/src/expressions/functions/spatial.ts index c16287d9..6fc5bb2e 100644 --- a/src/expressions/functions/spatial.ts +++ b/src/expressions/functions/spatial.ts @@ -21,7 +21,7 @@ import type { Expr } from "../../types"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/spatial/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/spatial/ | Cypher Documentation} * @group Cypher Functions * @category Spatial */ @@ -30,7 +30,7 @@ export function point(variable: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/4.3/functions/spatial/#functions-distance) + * @see {@link https://neo4j.com/docs/cypher-manual/4.3/functions/spatial/#functions-distance | Cypher Documentation} * @group Cypher Functions * @category Spatial * @deprecated No longer supported in Neo4j 5. Use {@link point.distance} instead. @@ -40,7 +40,7 @@ export function distance(lexpr: Expr, rexpr: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-distance) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-distance | Cypher Documentation} * @group Cypher Functions * @category Spatial * @example Generated Cypher: `point.distance(point1, point2)` @@ -50,7 +50,7 @@ point.distance = (lexpr: Expr, rexpr: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-withinBBox) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-withinBBox | Cypher Documentation} * @group Cypher Functions * @category Spatial */ diff --git a/src/expressions/functions/string.ts b/src/expressions/functions/string.ts index 38b1bb1f..c379ceb9 100644 --- a/src/expressions/functions/string.ts +++ b/src/expressions/functions/string.ts @@ -24,7 +24,7 @@ import { normalizeExpr } from "../../utils/normalize-variable"; import { CypherFunction } from "./CypherFunctions"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-btrim) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-btrim | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -35,7 +35,7 @@ export function btrim(original: string | Expr, trimCharacter?: string | Expr): C } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-left) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-left | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -44,7 +44,7 @@ export function left(original: Expr, length: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-lower) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-lower | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -53,7 +53,7 @@ export function lower(original: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -64,7 +64,7 @@ export function ltrim(original: Expr | string, trimCharacter?: string | Expr): C } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String * @param normalForm - A string with the normal form to use or a Cypher expression @@ -76,7 +76,7 @@ export function normalize(input: Expr, normalForm?: NormalizationType | Expr): C } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -85,7 +85,7 @@ export function replace(original: Expr, search: Expr, replace: Expr): CypherFunc } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category List * @category String @@ -95,7 +95,7 @@ export function right(original: Expr, length: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -106,7 +106,7 @@ export function rtrim(original: Expr | string, trimCharacter?: string | Expr): C } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -115,7 +115,7 @@ export function split(original: Expr, delimiter: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -124,7 +124,7 @@ export function substring(original: Expr, start: Expr, length?: Expr): CypherFun } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -133,7 +133,7 @@ export function toLower(original: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -142,7 +142,7 @@ export function toString(expression: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -151,7 +151,7 @@ export function toStringOrNull(expression: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -160,7 +160,7 @@ export function toUpper(original: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/ | Cypher Documentation} * @group Cypher Functions * @category String */ @@ -169,7 +169,7 @@ export function trim(original: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-upper) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/string/#functions-upper | Cypher Documentation} * @group Cypher Functions * @category String */ diff --git a/src/expressions/functions/temporal.ts b/src/expressions/functions/temporal.ts index ff3464cc..7e09f8dc 100644 --- a/src/expressions/functions/temporal.ts +++ b/src/expressions/functions/temporal.ts @@ -23,7 +23,7 @@ import { normalizeExpr } from "../../utils/normalize-variable"; import { CypherFunction } from "./CypherFunctions"; /** Temporal unit to be used in `.truncate()` functions - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-truncate | Cypher Documentation} */ export type TemporalUnit = | "millennium" @@ -37,7 +37,7 @@ export type TemporalUnit = | "day"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -46,7 +46,7 @@ export function cypherDatetime(timezone?: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-timestamp) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-timestamp | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -57,7 +57,7 @@ cypherDatetime.fromepoch = (seconds: number | Expr, nanoseconds: number | Expr): }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-timestamp) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-timestamp | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -68,7 +68,7 @@ cypherDatetime.fromepochmilis = (seconds: number | Expr, nanoseconds: number | E }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-realtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-realtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -77,7 +77,7 @@ cypherDatetime.realtime = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-statement) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-statement | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -86,7 +86,7 @@ cypherDatetime.statement = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-transaction) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-transaction | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -95,7 +95,7 @@ cypherDatetime.transaction = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-datetime-truncate | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -113,7 +113,7 @@ cypherDatetime.truncate = ( }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date | Cypher Documentation} * @group Cypher Functions * @category Temporal * @example @@ -146,7 +146,7 @@ export function cypherDate(timezone?: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-realtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-realtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -155,7 +155,7 @@ cypherDate.realtime = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-statement) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-statement | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -164,7 +164,7 @@ cypherDate.statement = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-transaction) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-transaction | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -173,7 +173,7 @@ cypherDate.transaction = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-date-truncate | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -191,7 +191,7 @@ cypherDate.truncate = ( }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -200,7 +200,7 @@ export function cypherLocalDatetime(timezone?: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-realtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-realtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -209,7 +209,7 @@ cypherLocalDatetime.realtime = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-statement) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-statement | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -218,7 +218,7 @@ cypherLocalDatetime.statement = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-transaction) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-transaction | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -227,7 +227,7 @@ cypherLocalDatetime.transaction = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localdatetime-truncate | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -245,7 +245,7 @@ cypherLocalDatetime.truncate = ( }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -254,7 +254,7 @@ export function cypherLocalTime(timezone?: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-realtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-realtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -263,7 +263,7 @@ cypherLocalTime.realtime = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-statement) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-statement | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -272,7 +272,7 @@ cypherLocalTime.statement = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-transaction) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-transaction | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -281,7 +281,7 @@ cypherLocalTime.transaction = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-localtime-truncate | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -299,7 +299,7 @@ cypherLocalTime.truncate = ( }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -309,7 +309,7 @@ export function cypherTime(timezone?: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-realtime) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-realtime | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -318,7 +318,7 @@ cypherTime.realtime = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-statement) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-statement | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -327,7 +327,7 @@ cypherTime.statement = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-transaction) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-transaction | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -336,7 +336,7 @@ cypherTime.transaction = (timezone?: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-truncate) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/#functions-time-truncate | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -354,7 +354,7 @@ cypherTime.truncate = ( }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -363,7 +363,7 @@ export function duration(components: Expr): CypherFunction { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-between) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-between | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -372,7 +372,7 @@ duration.between = (instant1: Expr, instant2: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-inmonths) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-inmonths | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -381,7 +381,7 @@ duration.inMonths = (instant1: Expr, instant2: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-indays) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-indays | Cypher Documentation} * @group Cypher Functions * @category Temporal */ @@ -390,7 +390,7 @@ duration.inDays = (instant1: Expr, instant2: Expr): CypherFunction => { }; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-inseconds) + * @see {@link https://neo4j.com/docs/cypher-manual/current/functions/temporal/duration/#functions-duration-inseconds | Cypher Documentation} * @group Cypher Functions * @category Temporal */ diff --git a/src/expressions/labels/label-expressions.ts b/src/expressions/labels/label-expressions.ts index 3c246b6c..1147088e 100644 --- a/src/expressions/labels/label-expressions.ts +++ b/src/expressions/labels/label-expressions.ts @@ -26,7 +26,7 @@ export type LabelOperator = "&" | "|" | "!" | "%"; /** * Label Expression - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions | Cypher Documentation} * @group Patterns */ export abstract class LabelExpr implements CypherCompilable { @@ -100,7 +100,7 @@ class WildcardLabelExpr extends LabelExpr { } /** Generates an `&` operator between labels or types - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions | Cypher Documentation} * @group Expressions * @category Operators */ @@ -109,7 +109,7 @@ function labelAnd(...labels: Array): LabelExpr { } /** Generates an `|` operator between labels or types - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions | Cypher Documentation} * @group Expressions * @category Operators */ @@ -118,7 +118,7 @@ function labelOr(...labels: Array): LabelExpr { } /** Generates an `!` operator for a label or type - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions | Cypher Documentation} * @group Expressions * @category Operators */ @@ -127,7 +127,7 @@ function labelNot(label: string | LabelExpr): LabelExpr { } /** Generates an wildcard (`%`) operator to substitute a label or type - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#label-expressions | Cypher Documentation} * @group Expressions * @category Operators */ diff --git a/src/expressions/list/ListComprehension.ts b/src/expressions/list/ListComprehension.ts index 1e7c52b6..eef6e46b 100644 --- a/src/expressions/list/ListComprehension.ts +++ b/src/expressions/list/ListComprehension.ts @@ -29,7 +29,7 @@ import { compileCypherIfExists } from "../../utils/compile-cypher-if-exists"; export interface ListComprehension extends WithWhere {} /** Represents a List comprehension - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/lists/#cypher-list-comprehension) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/lists/#cypher-list-comprehension | Cypher Documentation} * @group Lists */ @mixin(WithWhere) diff --git a/src/expressions/list/ListExpr.ts b/src/expressions/list/ListExpr.ts index 0f447ce8..e24aa57d 100644 --- a/src/expressions/list/ListExpr.ts +++ b/src/expressions/list/ListExpr.ts @@ -22,7 +22,7 @@ import type { CypherCompilable, Expr } from "../../types"; import { ListIndex } from "./ListIndex"; /** Represents a List - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/lists/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/lists/ | Cypher Documentation} * @group Lists * @example * ```ts diff --git a/src/expressions/list/PatternComprehension.ts b/src/expressions/list/PatternComprehension.ts index 56a94b2d..451dd700 100644 --- a/src/expressions/list/PatternComprehension.ts +++ b/src/expressions/list/PatternComprehension.ts @@ -29,7 +29,7 @@ import { compileCypherIfExists } from "../../utils/compile-cypher-if-exists"; export interface PatternComprehension extends WithWhere {} /** Represents a Pattern comprehension - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/values-and-types/lists/#cypher-pattern-comprehension) + * @see {@link https://neo4j.com/docs/cypher-manual/current/values-and-types/lists/#cypher-pattern-comprehension | Cypher Documentation} * @group Patterns */ @mixin(WithWhere) diff --git a/src/expressions/map/MapExpr.ts b/src/expressions/map/MapExpr.ts index 56fdd88d..7091655b 100644 --- a/src/expressions/map/MapExpr.ts +++ b/src/expressions/map/MapExpr.ts @@ -22,7 +22,7 @@ import type { CypherCompilable, Expr } from "../../types"; import { serializeMap } from "../../utils/serialize-map"; /** Represents a Map - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/maps/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/maps/ | Cypher Documentation} * @group Maps */ export class MapExpr implements CypherCompilable { diff --git a/src/expressions/map/MapProjection.ts b/src/expressions/map/MapProjection.ts index b314def0..a409b1a0 100644 --- a/src/expressions/map/MapProjection.ts +++ b/src/expressions/map/MapProjection.ts @@ -26,7 +26,7 @@ import { serializeMap } from "../../utils/serialize-map"; import { MapExpr } from "./MapExpr"; /** Represents a Map projection - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/maps/#cypher-map-projection) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/maps/#cypher-map-projection | Cypher Documentation} * @group Maps * @example * ```cypher diff --git a/src/expressions/operations/boolean.ts b/src/expressions/operations/boolean.ts index bfd651fd..c61fe9ed 100644 --- a/src/expressions/operations/boolean.ts +++ b/src/expressions/operations/boolean.ts @@ -85,7 +85,7 @@ class NotOp extends BooleanOp { } /** Generates an `AND` operator between the given predicates - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean | Cypher Documentation} * @group Operators * @category Boolean * @example @@ -115,7 +115,7 @@ export function and(...ops: Array): Predicate | undefined } /** Generates an `NOT` operator before the given predicate - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean | Cypher Documentation} * @group Operators * @category Boolean * @example @@ -135,7 +135,7 @@ export function not(child: Predicate): BooleanOp { } /** Generates an `OR` operator between the given predicates - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean | Cypher Documentation} * @group Operators * @category Boolean * @example @@ -165,7 +165,7 @@ export function or(...ops: Array): Predicate | undefined } /** Generates an `XOR` operator between the given predicates - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean | Cypher Documentation} * @group Operators * @category Boolean * @example diff --git a/src/expressions/operations/comparison.ts b/src/expressions/operations/comparison.ts index 2e875dbe..8139a1f4 100644 --- a/src/expressions/operations/comparison.ts +++ b/src/expressions/operations/comparison.ts @@ -94,7 +94,7 @@ function createOp(op: ComparisonOperator, leftExpr: Expr, rightExpr?: Expr): Com } /** Equality (`=`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -103,7 +103,7 @@ export function eq(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Inequality (`<>`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -112,7 +112,7 @@ export function neq(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Greater Than (`>`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -121,7 +121,7 @@ export function gt(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Greater Than Equal (`>=`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -130,7 +130,7 @@ export function gte(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Less Than (`<`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -139,7 +139,7 @@ export function lt(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Less Than Equal (`<=`) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -148,7 +148,7 @@ export function lte(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** `IS NULL` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison * @example @@ -161,7 +161,7 @@ export function isNull(childExpr: Expr): ComparisonOp { } /** `IS NOT NULL` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison * @example @@ -174,7 +174,7 @@ export function isNotNull(childExpr: Expr): ComparisonOp { } /** `IN` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -183,7 +183,7 @@ export function inOp(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** `CONTAINS` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -192,7 +192,7 @@ export function contains(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** `STARTS WITH` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -201,7 +201,7 @@ export function startsWith(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** `ENDS WITH` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -210,7 +210,7 @@ export function endsWith(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** Matching (=~) operator. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -219,7 +219,7 @@ export function matches(leftExpr: Expr, rightExpr: Expr): ComparisonOp { } /** `IS NORMALIZED` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ @@ -228,7 +228,7 @@ export function isNormalized(leftExpr: Expr, normalizationType?: NormalizationTy } /** `IS NOT NORMALIZED` operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ diff --git a/src/expressions/operations/math.ts b/src/expressions/operations/math.ts index ed7a2f8b..aa628486 100644 --- a/src/expressions/operations/math.ts +++ b/src/expressions/operations/math.ts @@ -17,9 +17,9 @@ * limitations under the License. */ -import type { Expr } from "../../types"; -import type { CypherEnvironment } from "../../Environment"; import { CypherASTNode } from "../../CypherASTNode"; +import type { CypherEnvironment } from "../../Environment"; +import type { Expr } from "../../types"; type MathOperator = "+" | "-" | "*" | "/" | "%" | "^"; @@ -49,7 +49,7 @@ function createOp(op: MathOperator, exprs: Expr[]): MathOp { } /** Plus (+) operator. This operator may be used for addition operations between numbers or for string concatenation. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @see [String Concatenation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#syntax-concatenating-two-strings) * @group Operators * @category Math @@ -61,7 +61,7 @@ export function plus(...exprs: Expr[]): MathOp { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @group Operators * @category Math */ @@ -70,7 +70,7 @@ export function minus(leftExpr: Expr, rightExpr: Expr): MathOp { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @group Operators * @category Math */ @@ -79,7 +79,7 @@ export function multiply(leftExpr: Expr, rightExpr: Expr): MathOp { } /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @group Operators * @category Math */ @@ -88,7 +88,7 @@ export function divide(leftExpr: Expr, rightExpr: Expr): MathOp { } /** Modulus (%) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @group Operators * @category Math */ @@ -97,7 +97,7 @@ export function mod(leftExpr: Expr, rightExpr: Expr): MathOp { } /** Power (^) operator - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation} * @group Operators * @category Math */ diff --git a/src/expressions/subquery/Collect.ts b/src/expressions/subquery/Collect.ts index d19e755c..55bc5aae 100644 --- a/src/expressions/subquery/Collect.ts +++ b/src/expressions/subquery/Collect.ts @@ -22,7 +22,7 @@ import { padBlock } from "../../utils/pad-block"; import { Subquery } from "./Subquery"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/subqueries/collect/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/subqueries/collect/ | Cypher Documentation} * @group Other */ export class Collect extends Subquery { diff --git a/src/expressions/subquery/Count.ts b/src/expressions/subquery/Count.ts index 3411058f..48b8d676 100644 --- a/src/expressions/subquery/Count.ts +++ b/src/expressions/subquery/Count.ts @@ -22,7 +22,7 @@ import { padBlock } from "../../utils/pad-block"; import { Subquery } from "./Subquery"; /** COUNT subquery expression - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#count-subqueries) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#count-subqueries | Cypher Documentation} * @group Other */ export class Count extends Subquery { diff --git a/src/expressions/subquery/Exists.ts b/src/expressions/subquery/Exists.ts index 3e214ced..65a543e3 100644 --- a/src/expressions/subquery/Exists.ts +++ b/src/expressions/subquery/Exists.ts @@ -22,7 +22,7 @@ import { padBlock } from "../../utils/pad-block"; import { Subquery } from "./Subquery"; /** - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#existential-subqueries) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/#existential-subqueries | Cypher Documentation} * @group Other */ export class Exists extends Subquery { diff --git a/src/pattern/Pattern.ts b/src/pattern/Pattern.ts index 3ee6dc8f..2c371abd 100644 --- a/src/pattern/Pattern.ts +++ b/src/pattern/Pattern.ts @@ -49,7 +49,7 @@ export type RelationshipPattern = { export interface Pattern extends WithWhere {} /** Represents a pattern of a single node or n-relationships to be used in clauses. - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/patterns/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/patterns/ | Cypher Documentation} * @group Patterns */ @mixin(WithWhere) diff --git a/src/pattern/quantified-patterns/QuantifiedPattern.ts b/src/pattern/quantified-patterns/QuantifiedPattern.ts index 82d84898..4d5aad31 100644 --- a/src/pattern/quantified-patterns/QuantifiedPattern.ts +++ b/src/pattern/quantified-patterns/QuantifiedPattern.ts @@ -31,7 +31,7 @@ export type Quantifier = }; /** Represents a quantified path pattern as a {@link Pattern} with at least one relationship and a quantifier of the form `{1,2}` - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/patterns/variable-length-patterns/#quantified-path-patterns) + * @see {@link https://neo4j.com/docs/cypher-manual/current/patterns/variable-length-patterns/#quantified-path-patterns | Cypher Documentation} * @group Patterns */ export class QuantifiedPattern implements CypherCompilable { diff --git a/src/procedures/CypherProcedure.ts b/src/procedures/CypherProcedure.ts index 3e96bcbd..931d827e 100644 --- a/src/procedures/CypherProcedure.ts +++ b/src/procedures/CypherProcedure.ts @@ -26,7 +26,7 @@ import type { YieldProjectionColumn } from "./Yield"; import { Yield } from "./Yield"; /** Cypher Procedure that does not yield columns - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call/ | Cypher Documentation} * @group Procedures */ export class VoidCypherProcedure extends Clause { @@ -58,7 +58,7 @@ export class VoidCypherProcedure extends Clause { } /** Cypher Procedure - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call/ | Cypher Documentation} * @group Procedures */ export class CypherProcedure extends VoidCypherProcedure { diff --git a/src/procedures/Yield.ts b/src/procedures/Yield.ts index fccea6c5..88cf5927 100644 --- a/src/procedures/Yield.ts +++ b/src/procedures/Yield.ts @@ -54,7 +54,7 @@ export interface Yield WithOrder {} /** Yield statement after a Procedure CALL - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/clauses/call/#call-call-a-procedure-call-yield-star) + * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/call/#call-call-a-procedure-call-yield-star | Cypher Documentation} * @group Procedures */ @mixin( diff --git a/src/references/Path.ts b/src/references/Path.ts index 3dfe68d1..8a751603 100644 --- a/src/references/Path.ts +++ b/src/references/Path.ts @@ -21,7 +21,7 @@ import type { NamedReference } from "./Variable"; import { Variable } from "./Variable"; /** Reference to a path variable - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/patterns) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/patterns | Cypher Documentation} * @group Variables */ export class PathVariable extends Variable { diff --git a/src/types.ts b/src/types.ts index bf66e194..f22d3588 100644 --- a/src/types.ts +++ b/src/types.ts @@ -43,7 +43,7 @@ import type { Variable } from "./references/Variable"; export type Operation = BooleanOp | ComparisonOp | MathOp; /** Represents a Cypher Expression - * @see [Cypher Documentation](https://neo4j.com/docs/cypher-manual/current/syntax/expressions/) + * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/expressions/ | Cypher Documentation} */ export type Expr = | Operation diff --git a/typedoc.json b/typedoc.json index 9e8f8e2f..cf1362ab 100644 --- a/typedoc.json +++ b/typedoc.json @@ -14,5 +14,9 @@ "gitRemote": "origin", "out": "./docs/build/site/reference", "readme": "none", - "highlightLanguages": ["css", "html", "javascript", "json", "jsonc", "json5", "tsx", "typescript", "cypher"] + "highlightLanguages": ["css", "html", "javascript", "json", "jsonc", "json5", "tsx", "typescript", "cypher"], + "validation": { + "invalidLink": true + }, + "intentionallyNotExported": ["CypherCompilable"] }