Pular para o conteúdo principal

library_private_types_in_public_api

Saiba mais sobre a regra de lint library_private_types_in_public_api.

Estável
Recomendado
Lançado no Dart 2.14

Evite usar tipos privados em APIs públicas.

Detalhes

#

EVITE usar tipos privados de biblioteca em APIs públicas.

Para fins desta lint, uma API pública é considerada qualquer declaração de nível superior ou de membro, a menos que a declaração seja privada da biblioteca ou esteja contida em uma declaração privada da biblioteca. Os seguintes usos de tipos são verificados:

  • o tipo de retorno de uma função ou método,
  • o tipo de qualquer parâmetro de uma função ou método,
  • o limite (bound) de um parâmetro de tipo de qualquer função, método, classe, mixin, tipo estendido por uma extension, ou alias de tipo,
  • o tipo de qualquer variável ou campo de nível superior,
  • qualquer tipo usado na declaração de um alias de tipo (por exemplo, typedef F = _Private Function();), ou
  • qualquer tipo usado na cláusula on de uma extension ou de um mixin

RUIM:

dart
f(_Private p) { ... }
class _Private {}

BOM:

dart
f(String s) { ... }

Ativar

#

Para ativar a regra library_private_types_in_public_api, adicione library_private_types_in_public_api em linter > rules no seu arquivo analysis_options.yaml:

analysis_options.yaml
yaml
linter:
  rules:
    - library_private_types_in_public_api

Se você usa a sintaxe de mapa YAML para configurar as regras de lint, adicione library_private_types_in_public_api: true em linter > rules:

analysis_options.yaml
yaml
linter:
  rules:
    library_private_types_in_public_api: true

Encontrou essa página sem tradução ou que precisa de correção? Abra uma issue e nos ajude a manter esse site em PT-BR para ajudar pessoas como você.