Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes #1236

Merged
merged 4 commits into from
Nov 8, 2024
Merged

Documentation fixes #1236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
35a244b
add note that explicit transactions do not support CALL IN TRANSACTIONS
MaxAake Oct 29, 2024
e90a283
standardize usage of link tag in deprecations
MaxAake Oct 29, 2024
3861bbc
fixed client certificate links
MaxAake Oct 30, 2024
ce6da77
fix other link tags with minor issues
MaxAake Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/core/src/client-certificate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ export default class ClientCertificate {
/**
* Provides a client certificate to the driver for mutual TLS.
*
* The driver will call {@link ClientCertificateProvider#hasUpdate()} to check if the client wants to update the certificate.
* If so, it will call {@link ClientCertificateProvider#getCertificate()} to get the new certificate.
* The driver will call {@link ClientCertificateProvider#hasUpdate} to check if the client wants to update the certificate.
* If so, it will call {@link ClientCertificateProvider#getClientCertificate} to get the new certificate.
*
* The certificate is only used as a second factor for authentication authenticating the client.
* The DMBS user still needs to authenticate with an authentication token.
Expand Down Expand Up @@ -103,7 +103,7 @@ export class ClientCertificateProvider {
/**
* Returns the certificate to use for new connections.
*
* Will be called by the driver after {@link ClientCertificateProvider#hasUpdate()} returned true
* Will be called by the driver after {@link ClientCertificateProvider#hasUpdate} returned true
* or when the driver establishes the first connection.
*
* @returns {Promise<ClientCertificate>|ClientCertificate} the certificate to use for new connections
Expand Down
14 changes: 11 additions & 3 deletions packages/core/src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ class Session {
/**
* Return the bookmarks received following the last completed {@link Transaction}.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
*
* @return {string[]} A reference to a previous transaction.
* @see {@link Session#lastBookmarks}
Expand Down Expand Up @@ -385,7 +385,7 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
*
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
Expand All @@ -410,7 +410,7 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
*
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
Expand Down Expand Up @@ -446,6 +446,10 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
* "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
* {@link Session#run} for these).
*
* @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
Expand All @@ -468,6 +472,10 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
* "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
* {@link Session#run} for these).
*
* @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/transaction-promise.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { TxConfig } from './internal/tx-config'
import NotificationFilter from './notification-filter'

/**
* Represents a {@link Promise<Transaction>} object and a {@link Transaction} object.
* Represents a Promise<{@link Transaction}> object and a {@link Transaction} object.
*
* Resolving this object promise verifies the result of the transaction begin and returns the {@link Transaction} object in case of success.
*
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ export class Config {
this.resolver = undefined

/**
* Configure filter for Notification objects returned in {@Link ResultSummary#notifications}.
* Configure filter for Notification objects returned in {@link ResultSummary#notifications}.
*
* See {@link SessionConfig#notificationFilter} for usage instructions.
*
Expand Down
6 changes: 3 additions & 3 deletions packages/neo4j-driver-deno/lib/core/client-certificate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ export default class ClientCertificate {
/**
* Provides a client certificate to the driver for mutual TLS.
*
* The driver will call {@link ClientCertificateProvider#hasUpdate()} to check if the client wants to update the certificate.
* If so, it will call {@link ClientCertificateProvider#getCertificate()} to get the new certificate.
* The driver will call {@link ClientCertificateProvider#hasUpdate} to check if the client wants to update the certificate.
* If so, it will call {@link ClientCertificateProvider#getClientCertificate} to get the new certificate.
*
* The certificate is only used as a second factor for authentication authenticating the client.
* The DMBS user still needs to authenticate with an authentication token.
Expand Down Expand Up @@ -103,7 +103,7 @@ export class ClientCertificateProvider {
/**
* Returns the certificate to use for new connections.
*
* Will be called by the driver after {@link ClientCertificateProvider#hasUpdate()} returned true
* Will be called by the driver after {@link ClientCertificateProvider#hasUpdate} returned true
* or when the driver establishes the first connection.
*
* @returns {Promise<ClientCertificate>|ClientCertificate} the certificate to use for new connections
Expand Down
14 changes: 11 additions & 3 deletions packages/neo4j-driver-deno/lib/core/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ class Session {
/**
* Return the bookmarks received following the last completed {@link Transaction}.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
*
* @return {string[]} A reference to a previous transaction.
* @see {@link Session#lastBookmarks}
Expand Down Expand Up @@ -385,7 +385,7 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
*
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
Expand All @@ -410,7 +410,7 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
* @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
*
* @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
Expand Down Expand Up @@ -446,6 +446,10 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
* "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
* {@link Session#run} for these).
*
* @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
Expand All @@ -468,6 +472,10 @@ class Session {
* delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
* `maxTransactionRetryTime` property in milliseconds.
*
* NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using
* "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call
* {@link Session#run} for these).
*
* @param {function(tx: ManagedTransaction): Promise} transactionWork - Callback that executes operations against
* a given {@link Transaction}.
* @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver-deno/lib/core/transaction-promise.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { TxConfig } from './internal/tx-config.ts'
import NotificationFilter from './notification-filter.ts'

/**
* Represents a {@link Promise<Transaction>} object and a {@link Transaction} object.
* Represents a Promise<{@link Transaction}> object and a {@link Transaction} object.
*
* Resolving this object promise verifies the result of the transaction begin and returns the {@link Transaction} object in case of success.
*
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver-deno/lib/core/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ export class Config {
this.resolver = undefined

/**
* Configure filter for Notification objects returned in {@Link ResultSummary#notifications}.
* Configure filter for Notification objects returned in {@link ResultSummary#notifications}.
*
* See {@link SessionConfig#notificationFilter} for usage instructions.
*
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver/src/result-rx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export default class RxResult {
*
* This method won't need to be called in normal stream operation. It only applies to the case when the stream is paused.
*
* This method is method won't start the consuming records if the ${@link records()} stream didn't get subscribed.
* This method is method won't start the consuming records if the {@link records} stream didn't get subscribed.
* @experimental
* @returns {Promise<void>} - A promise that resolves when the stream is resumed.
*/
Expand Down