Function decorateWithExplain

src/explain.ts:107–124

(
  command: Document,
  explain: Explain
)

 * @param options - the options containing the explain verbosity
 */
export function decorateWithExplain(
  command: Document,
  explain: Explain
): {
  explain: Document;
  verbosity: ExplainVerbosity;
  maxTimeMS?: number;
} {
  type ExplainCommand = ReturnType<typeof decorateWithExplain>;
  const { verbosity, maxTimeMS } = explain;
  const baseCommand: ExplainCommand = { explain: command, verbosity };

  if (typeof maxTimeMS === class="st">'number') {
    baseCommand.maxTimeMS = maxTimeMS;
  }

  return baseCommand;
}