//#region src/format-cns/format-cns.d.ts
/** Options of `formatCns`. */
export type FormatCnsOptions = {
  /** Whether to left pad the value with zeros up to the number of slots in the pattern (default: `false`). */
  pad?: boolean;
};
/**
 * Formats a CNS (Cartão Nacional de Saúde) number into the common display groups of 3-4-4-4
 * digits separated by spaces.
 *
 * @param {string|number} value - The CNS value to be formatted. It can be a string or a number.
 * @param {FormatCnsOptions} [options] - Optional formatting options.
 * @param {boolean} options.pad - If true, pads the value with leading zeros if necessary.
 * @returns {string} The formatted CNS string in the pattern "000 0000 0000 0000".
 *
 * @example
 * ```typescript
 * formatCns("123456789010000"); // "123 4567 8901 0000"
 * formatCns(123456789010000); // "123 4567 8901 0000"
 * formatCns("89010001", { pad: true }); // "000 0000 8901 0001"
 * ```
 *
 * @see Official: https://rni-docs.anvisa.gov.br/docs/regras_gerais/validacoes/validacaoCNS/
 * ANVISA's two validation routines, the ones implemented here. The page sits behind a bot filter
 * and answers HTTP 403 to every non-browser client, so it has to be opened in a browser.
 * @see Based on: https://integracao.esusab.ufsc.br/ledi/documentacao/regras/algoritmo_CNS.html
 * e-SUS APS documentation of the same DATASUS algorithm, reachable without a browser. It applies
 * the provisional routine to numbers starting with 5, 7, 8 or 9; this implementation follows the
 * ANVISA page, which restricts it to 7, 8 and 9, so a 5 prefixed number is rejected even when its
 * weighted sum checks out.
 */
export declare const formatCns: (value: string | number, options?: FormatCnsOptions) => string;
//#endregion