Skip to content

Commit 28b1907

Browse files
authored
Fix deprecation methods replacement links at Session class (#1046)
The @deprected tag doesn't accept links, so the links were moved to the @see section.
1 parent f0646a0 commit 28b1907

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

packages/core/src/session.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,10 @@ class Session {
325325
/**
326326
* Return the bookmarks received following the last completed {@link Transaction}.
327327
*
328-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
328+
* @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
329329
*
330330
* @return {string[]} A reference to a previous transaction.
331+
* @see {@link Session#lastBookmarks}
331332
*/
332333
lastBookmark (): string[] {
333334
return this.lastBookmarks()
@@ -358,13 +359,14 @@ class Session {
358359
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
359360
* `maxTransactionRetryTime` property in milliseconds.
360361
*
361-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
362+
* @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
362363
*
363364
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
364365
* a given {@link Transaction}.
365366
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
366367
* @return {Promise} Resolved promise as returned by the given function or rejected promise when given
367368
* function or commit fails.
369+
* @see {@link Session#executeRead}
368370
*/
369371
readTransaction<T>(
370372
transactionWork: TransactionWork<T>,
@@ -382,13 +384,14 @@ class Session {
382384
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
383385
* `maxTransactionRetryTime` property in milliseconds.
384386
*
385-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
387+
* @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
386388
*
387389
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
388390
* a given {@link Transaction}.
389391
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
390392
* @return {Promise} Resolved promise as returned by the given function or rejected promise when given
391393
* function or commit fails.
394+
* @see {@link Session#executeWrite}
392395
*/
393396
writeTransaction<T>(
394397
transactionWork: TransactionWork<T>,

packages/neo4j-driver-deno/lib/core/session.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,10 @@ class Session {
325325
/**
326326
* Return the bookmarks received following the last completed {@link Transaction}.
327327
*
328-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
328+
* @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
329329
*
330330
* @return {string[]} A reference to a previous transaction.
331+
* @see {@link Session#lastBookmarks}
331332
*/
332333
lastBookmark (): string[] {
333334
return this.lastBookmarks()
@@ -358,13 +359,14 @@ class Session {
358359
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
359360
* `maxTransactionRetryTime` property in milliseconds.
360361
*
361-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
362+
* @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
362363
*
363364
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
364365
* a given {@link Transaction}.
365366
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
366367
* @return {Promise} Resolved promise as returned by the given function or rejected promise when given
367368
* function or commit fails.
369+
* @see {@link Session#executeRead}
368370
*/
369371
readTransaction<T>(
370372
transactionWork: TransactionWork<T>,
@@ -382,13 +384,14 @@ class Session {
382384
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
383385
* `maxTransactionRetryTime` property in milliseconds.
384386
*
385-
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
387+
* @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
386388
*
387389
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
388390
* a given {@link Transaction}.
389391
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
390392
* @return {Promise} Resolved promise as returned by the given function or rejected promise when given
391393
* function or commit fails.
394+
* @see {@link Session#executeWrite}
392395
*/
393396
writeTransaction<T>(
394397
transactionWork: TransactionWork<T>,

0 commit comments

Comments
 (0)