diff --git a/packages/core/src/driver.ts b/packages/core/src/driver.ts index 2f6fed974..1399d7819 100644 --- a/packages/core/src/driver.ts +++ b/packages/core/src/driver.ts @@ -271,14 +271,14 @@ class SessionConfig { * This configuration enables filter notifications by: * * * the minimum severity level ({@link NotificationFilterMinimumSeverityLevel}) - * * disabling notification categories ({@link NotificationFilterDisabledCategory}) + * * disabling notification classification ({@link NotificationFilterDisabledClassification}) * * * Disabling notifications can be done by defining the minimum severity level to 'OFF'. * At driver level, when omitted, uses the server's default. * At session level, when omitted, defaults to what filters have been configured at driver level. * - * Disabling categories or severities allows the server to skip analysis for those, which can speed up query + * Disabling classifications or severities allows the server to skip analysis for those, which can speed up query * execution. * * @example @@ -287,9 +287,9 @@ class SessionConfig { * database: 'neo4j', * notificationFilter: { * minimumSeverityLevel: neo4j.notificationFilterMinimumSeverityLevel.WARNING, // or 'WARNING - * disabledCategories: [ - * neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT' - * neo4j.notificationFilterDisabledCategory.DEPRECATION // or 'DEPRECATION' + * disabledClassifications: [ + * neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT' + * neo4j.notificationFilterDisabledClassification.DEPRECATION // or 'DEPRECATION' * ] * } * }) @@ -309,18 +309,18 @@ class SessionConfig { * // or driver.session({ database: 'neo4j', notificationFilter: undefined }) * * // using default minimum severity level, but disabling 'HINT' and 'UNRECOGNIZED' - * // notification categories + * // notification classifications * const sessionWithDefaultSeverityLevel = driver.session({ * database: 'neo4j', * notificationFilter: { - * disabledCategories: [ - * neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT' - * neo4j.notificationFilterDisabledCategory.UNRECOGNIZED // or 'UNRECOGNIZED' + * disabledClassifications: [ + * neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT' + * neo4j.notificationFilterDisabledClassification.UNRECOGNIZED // or 'UNRECOGNIZED' * ] * } * }) * - * // using default disabled categories, but configuring minimum severity level to 'WARNING' + * // using default disabled classifications, but configuring minimum severity level to 'WARNING' * const sessionWithDefaultSeverityLevel = driver.session({ * database: 'neo4j', * notificationFilter: { diff --git a/packages/core/src/notification-filter.ts b/packages/core/src/notification-filter.ts index 6218845ff..a7313b6a8 100644 --- a/packages/core/src/notification-filter.ts +++ b/packages/core/src/notification-filter.ts @@ -44,6 +44,7 @@ type NotificationFilterDisabledCategory = ExcludeUnknown */ /** * Constants that represents the disabled categories in the {@link NotificationFilter} + * @deprecated use {@link notificationFilterDisabledClassification} instead. */ const notificationFilterDisabledCategory: EnumRecord = { HINT: 'HINT', @@ -65,7 +66,7 @@ type NotificationFilterDisabledClassification = ExcludeUnknown = notificationFilterDisabledCategory @@ -103,6 +104,7 @@ class NotificationFilter { * and it must not be enabled at same time. * * @type {?NotificationFilterDisabledCategory[]} + * @deprecated use{@link NotificationFilter#disabledClassifications} */ this.disabledCategories = undefined diff --git a/packages/core/src/notification.ts b/packages/core/src/notification.ts index c3f13669b..4c06e9be0 100644 --- a/packages/core/src/notification.ts +++ b/packages/core/src/notification.ts @@ -67,7 +67,8 @@ type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMAN * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory */ /** - * Constants that represents the Category in the {@link GqlStatusObject} + * Constants that represents the Category in the {@link Notification} + * @deprecated use {@link notificationClassification} instead. */ const notificationCategory: { [key in NotificationCategory]: key } = { HINT: 'HINT', diff --git a/packages/neo4j-driver-deno/lib/core/driver.ts b/packages/neo4j-driver-deno/lib/core/driver.ts index 1f8019cfb..122e89700 100644 --- a/packages/neo4j-driver-deno/lib/core/driver.ts +++ b/packages/neo4j-driver-deno/lib/core/driver.ts @@ -271,14 +271,14 @@ class SessionConfig { * This configuration enables filter notifications by: * * * the minimum severity level ({@link NotificationFilterMinimumSeverityLevel}) - * * disabling notification categories ({@link NotificationFilterDisabledCategory}) + * * disabling notification classification ({@link NotificationFilterDisabledClassification}) * * * Disabling notifications can be done by defining the minimum severity level to 'OFF'. * At driver level, when omitted, uses the server's default. * At session level, when omitted, defaults to what filters have been configured at driver level. * - * Disabling categories or severities allows the server to skip analysis for those, which can speed up query + * Disabling classifications or severities allows the server to skip analysis for those, which can speed up query * execution. * * @example @@ -287,9 +287,9 @@ class SessionConfig { * database: 'neo4j', * notificationFilter: { * minimumSeverityLevel: neo4j.notificationFilterMinimumSeverityLevel.WARNING, // or 'WARNING - * disabledCategories: [ - * neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT' - * neo4j.notificationFilterDisabledCategory.DEPRECATION // or 'DEPRECATION' + * disabledClassifications: [ + * neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT' + * neo4j.notificationFilterDisabledClassification.DEPRECATION // or 'DEPRECATION' * ] * } * }) @@ -309,18 +309,18 @@ class SessionConfig { * // or driver.session({ database: 'neo4j', notificationFilter: undefined }) * * // using default minimum severity level, but disabling 'HINT' and 'UNRECOGNIZED' - * // notification categories + * // notification classifications * const sessionWithDefaultSeverityLevel = driver.session({ * database: 'neo4j', * notificationFilter: { - * disabledCategories: [ - * neo4j.notificationFilterDisabledCategory.HINT, // or 'HINT' - * neo4j.notificationFilterDisabledCategory.UNRECOGNIZED // or 'UNRECOGNIZED' + * disabledClassifications: [ + * neo4j.notificationFilterDisabledClassification.HINT, // or 'HINT' + * neo4j.notificationFilterDisabledClassification.UNRECOGNIZED // or 'UNRECOGNIZED' * ] * } * }) * - * // using default disabled categories, but configuring minimum severity level to 'WARNING' + * // using default disabled classifications, but configuring minimum severity level to 'WARNING' * const sessionWithDefaultSeverityLevel = driver.session({ * database: 'neo4j', * notificationFilter: { diff --git a/packages/neo4j-driver-deno/lib/core/notification-filter.ts b/packages/neo4j-driver-deno/lib/core/notification-filter.ts index c58422f87..a46839b05 100644 --- a/packages/neo4j-driver-deno/lib/core/notification-filter.ts +++ b/packages/neo4j-driver-deno/lib/core/notification-filter.ts @@ -44,6 +44,7 @@ type NotificationFilterDisabledCategory = ExcludeUnknown */ /** * Constants that represents the disabled categories in the {@link NotificationFilter} + * @deprecated use {@link notificationFilterDisabledClassification} instead. */ const notificationFilterDisabledCategory: EnumRecord = { HINT: 'HINT', @@ -65,7 +66,7 @@ type NotificationFilterDisabledClassification = ExcludeUnknown = notificationFilterDisabledCategory @@ -103,6 +104,7 @@ class NotificationFilter { * and it must not be enabled at same time. * * @type {?NotificationFilterDisabledCategory[]} + * @deprecated use{@link NotificationFilter#disabledClassifications} */ this.disabledCategories = undefined diff --git a/packages/neo4j-driver-deno/lib/core/notification.ts b/packages/neo4j-driver-deno/lib/core/notification.ts index 98cdaffe7..f101fd337 100644 --- a/packages/neo4j-driver-deno/lib/core/notification.ts +++ b/packages/neo4j-driver-deno/lib/core/notification.ts @@ -67,7 +67,8 @@ type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMAN * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory */ /** - * Constants that represents the Category in the {@link GqlStatusObject} + * Constants that represents the Category in the {@link Notification} + * @deprecated use {@link notificationClassification} instead. */ const notificationCategory: { [key in NotificationCategory]: key } = { HINT: 'HINT',