@anpdgovbr/shared-types
Version:
Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)
38 lines • 1.25 kB
TypeScript
/**
* @file esfera.enum.ts
* @module enums
*
* @description
* Define o enum que representa a esfera governamental de um controlador público.
*
* @remarks
* Corresponde ao schema da API Quarkus de Controladores e é utilizado em `ControladorDto`
* quando o controlador pertence ao setor público.
*
* @since 0.2.0
*/
/**
* Enumeração que representa a esfera governamental de um controlador público.
*
* @public
*/
export declare enum Esfera {
/**
* Esfera Municipal (prefeituras, secretarias municipais, etc.).
*/
MUNICIPAL = "MUNICIPAL",
/**
* Esfera Estadual (governos estaduais, secretarias estaduais, etc.).
*/
ESTADUAL = "ESTADUAL",
/**
* Esfera Federal (ministérios, autarquias, etc.).
*/
FEDERAL = "FEDERAL"
}
export declare const ESFERA_VALUES: readonly [Esfera.MUNICIPAL, Esfera.ESTADUAL, Esfera.FEDERAL];
export type EsferaLiteral = (typeof ESFERA_VALUES)[number];
export declare function isEsfera(value: unknown): value is EsferaLiteral;
export declare function assertEsfera(value: unknown): asserts value is EsferaLiteral;
export declare function coerceEsfera(value: unknown, fallback?: EsferaLiteral): EsferaLiteral;
//# sourceMappingURL=esfera.enum.d.ts.map