Skip to content

Commit

Permalink
docs(AutoEncryption): adds documentation for extraOptions
Browse files Browse the repository at this point in the history
  • Loading branch information
daprahamian committed Aug 13, 2019
1 parent 3ecda98 commit 0d2018c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion lib/mongo_client.js
Expand Up @@ -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
*/

/**
Expand Down

0 comments on commit 0d2018c

Please sign in to comment.