nope/lib/helpers/idMethods.ts

/**
 * @author Martin Karkowski
 * @email m.karkowski@zema.de
 * @desc [description]
 */

import { v4 } from "uuid";
import { varifyString } from "./stringMethods";

/**
 * Generates an ID.
 *
 * @author M.Karkowski
 * @export
 * @param {{
 *   prestring?: string,
 *   useAsVar?: boolean
 * }} [options={}]
 * @return {string}
 */
export function generateId(
  options: {
    // PreString for the Var.
    prestring?: string;
    useAsVar?: boolean;
  } = {}
): string {
  let id = v4();

  if (typeof options.prestring === "string") {
    id = options.prestring + id;
  }

  if (options.useAsVar) {
    id = varifyString(id);
  }

  return id;
}