docs(NODE-5562): update upcoming crl option changes (#3836)

mongodb · Aug 23, 2023 · d6eac31 · d6eac31
1 parent 43673fa
commit d6eac31
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/connection_string.ts b/src/connection_string.ts
@@ -1108,7 +1108,7 @@ export const OPTIONS = {
   },
   sslCRL: {
     deprecated:
-      'sslCRL is deprecated and will be removed in the next major version. Please use tlsCertificateKeyFile instead.',
+      'sslCRL is deprecated and will be removed in the next major version and be replaced by tlsCRLFile in that release.',
     target: 'crl',
     transform({ values: [value] }) {
       return fs.readFileSync(String(value), { encoding: 'ascii' });

diff --git a/src/mongo_client.ts b/src/mongo_client.ts
@@ -814,7 +814,7 @@ export interface MongoOptions
    * | nodejs native option  | driver spec compliant option name             | legacy option name | driver option type |
    * |:----------------------|:----------------------------------------------|:-------------------|:-------------------|
    * | `ca`                  | `tlsCAFile`                                   | `sslCA`            | `string`           |
-   * | `crl`                 | N/A                                           | `sslCRL`           | `string`           |
+   * | `crl`                 | `tlsCRLFile` (next major version)             | `sslCRL`           | `string`           |
    * | `cert`                | `tlsCertificateFile`, `tlsCertificateKeyFile` | `sslCert`          | `string`           |
    * | `key`                 | `tlsCertificateKeyFile`                       | `sslKey`           | `string`           |
    * | `passphrase`          | `tlsCertificateKeyFilePassword`               | `sslPass`          | `string`           |