@anpdgovbr/shared-types/dist/cjs/enums/status-interno.enum.d.ts

Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)

/**
 * Enumeração que representa os possíveis status internos de um processo ou entidade.
 *
 * @remarks
 * Utilizado para indicar o estágio atual do processamento interno, desde a importação até a consolidação.
 *
 * @enum {string}
 * @readonly
 * @public
 */
export declare enum StatusInterno {
    IMPORTADO = "IMPORTADO",
    NOVO = "NOVO",
    EM_PROCESSAMENTO = "EM_PROCESSAMENTO",
    PROCESSADO = "PROCESSADO",
    CONSOLIDADO = "CONSOLIDADO"
}
/**
 * Lista imutável com todos os valores de {@link StatusInterno}.
 *
 * @public
 */
export declare const STATUS_INTERNO_VALUES: readonly [StatusInterno.IMPORTADO, StatusInterno.NOVO, StatusInterno.EM_PROCESSAMENTO, StatusInterno.PROCESSADO, StatusInterno.CONSOLIDADO];
/**
 * União literal dos valores de {@link StatusInterno} (string union).
 *
 * Útil para tipagem mais flexível sem acoplar ao enum do compilador.
 *
 * @public
 */
export type StatusInternoLiteral = (typeof STATUS_INTERNO_VALUES)[number];
/**
 * Verifica se um valor é um {@link StatusInternoLiteral} válido.
 *
 * @public
 */
export declare function isStatusInterno(value: unknown): value is StatusInternoLiteral;
/**
 * Asserção de tipo para {@link StatusInternoLiteral}.
 * Lança erro se o valor for inválido.
 *
 * @throws Error
 * @public
 */
export declare function assertStatusInterno(value: unknown): asserts value is StatusInternoLiteral;
/**
 * Coerção de valor para {@link StatusInternoLiteral} com fallback.
 *
 * @param value - Valor a ser convertido.
 * @param fallback - Valor padrão quando `value` não é válido (default: StatusInterno.NOVO).
 * @returns Valor coerente dentro do domínio de StatusInterno.
 * @public
 */
export declare function coerceStatusInterno(value: unknown, fallback?: StatusInternoLiteral): StatusInternoLiteral;
//# sourceMappingURL=status-interno.enum.d.ts.map