diff --git a/lib/mongo_client.js b/lib/mongo_client.js index d6fcc4c57d..b000ca85af 100644 --- a/lib/mongo_client.js +++ b/lib/mongo_client.js @@ -70,7 +70,11 @@ const CloseOperation = require('./operations/close'); * @property {string} [kmsProviders.local.key] The master key used to encrypt/decrypt data keys * @property {object} [schemaMap] A map of namespaces to a local JSON schema for encryption * @property {boolean} [bypassAutoEncryption] Allows the user to bypass auto encryption, maintaining implicit decryption - * @param {string} [extraOptions.mongocryptURI] A local process the driver communicates with to determine how to encrypt values in a command. Defaults to "mongodb://%2Fvar%2Fmongocryptd.sock" if domain sockets are available or "mongodb://localhost:27020" otherwise. + * @property {object} [extraOptions] Extra options related to the mongocryptd process + * @property {string} [extraOptions.mongocryptURI] A local process the driver communicates with to determine how to encrypt values in a command. Defaults to "mongodb://%2Fvar%2Fmongocryptd.sock" if domain sockets are available or "mongodb://localhost:27020" otherwise + * @property {boolean} [extraOptions.mongocryptdBypassSpawn=false] If true, autoEncryption will not attempt to spawn a mongocryptd before connecting + * @property {string} [extraOptions.mongocryptdSpawnPath] The path to the mongocryptd executable on the system + * @property {string[]} [extraOptions.mongocryptdSpawnArgs] Command line arguments to use when auto-spawning a mongocryptd */ /**