//#region src/format-cep/format-cep.d.ts /** Options of `formatCep`. */ export type FormatCepOptions = { /** Whether to left pad the value with zeros up to the number of slots in the pattern (default: `false`). */ pad?: boolean; }; /** * Formats a given value as a Brazilian postal code (CEP). * * @param {string|number} value - The value to be formatted, either as a string or a number. * @param {FormatCepOptions} [options] - Optional formatting options. * @param {boolean} options.pad - Whether to pad the value with leading zeros. * @returns {string} The formatted CEP string in the pattern "00000-000". * * @example * ```typescript * formatCep("01310930"); // "01310-930" * formatCep("1310930", { pad: true }); // "01310-930" * ``` * * @see Official: https://www.correios.com.br/enviar/precisa-de-ajuda/tudo-sobre-cep * @see Official: https://www.correios.com.br/enviar/precisa-de-ajuda/guia-de-enderecamento/guia-de-enderecamento */ export declare const formatCep: (value: string | number, options?: FormatCepOptions) => string; //#endregion