@mongosh/autocomplete

MongoDB Shell Autocomplete Package

Last updated 5 years ago by addaleax .

Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json

$ cnpm install @mongosh/autocomplete

SYNC missed versions from official npm registry.

`@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 implemeted APIs in @mongosh/shell-api

Installation

npm install -S @mongosh/errors

Current Tags

1.8.2 ... latest (3 years ago)

59 Versions

Maintainers (10)

Downloads

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 0

Dependencies (3)

Dev Dependencies (1)

mocha ^7.1.2

Dependents (1)

@mongosh/cli-repl

Copyright 2013 - present © cnpmjs.org | Home |