@mongosh/autocomplete

Package for MongoDB Shell

Usage

const autocomplete = require('@mongosh/autocomplete');
const serverVersion = '4.4.0';
const line = 'db.coll.fin';
const completions = autocomplete(serverVersion, line);
if (!completions || !completions.length) {
  return [];
}
const entries = completions[0].map((completion) => {
  return {
    completion,
  };
});

API

completions = autocomplete(serverVersion, line)

serverVersion: current version of MongoDB line: current line to autcomplete

Returns an array of completions, and the line we were autocompleting. For example:

const autocomplete = require('@mongosh/autocomplete');
const serverVersion = '4.4.0';
const line = 'db.coll.re';
const completions = autocomplete(serverVersion, line);
// returns:
// [
//   [ 'db.coll.renameCollection', 'db.coll.replaceOne', 'db.coll.reIndex' ],
//   'db.coll.re'
// ]

Autocomplete is based on currently implemented APIs in @mongosh/shell-api

Installation

npm install -S @mongosh/errors