Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Declare option fields as optional instead of wrapping the types in `Partial`

Abierto Apto para principiantes
  • ¿Algo no está bien?
#1,531 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
77/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
docker, node.js, typescript
Área
backend, testing

Línea de trabajo

Lee las declaraciones de opciones y las firmas de los métodos en packages/testcontainers/src/types.ts, packages/testcontainers/src/compose-runtime/clients/compose/types.ts y packages/testcontainers/src/testcontainers.ts. Compara también los tipos públicos y del cliente ExecOptions, incluido el campo log del cliente. El trabajo estará completo cuando los campos de opciones documenten sus valores predeterminados como opcionales, los métodos acepten esos tipos directamente y los tipos y las llamadas afectados sigan siendo coherentes.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement minor

What happens

Option types are declared with every field required, and each method then accepts Partial<...> and fills in defaults:

  • StopOptions in stop(options?: Partial<StopOptions>)
  • RestartOptions in restart(options?: Partial<RestartOptions>)
  • ExecOptions in exec(command, opts?: Partial<ExecOptions>)
  • ComposeDownOptions in down(options?: Partial<ComposeDownOptions>)

The exported type does not describe what a caller may pass, and a helper typed as StopOptions has to supply every field. The defaults (timeout: 0, remove, removeVolumes: true) are not visible in the type or in JSDoc.

There are also two ExecOptions types: the public one in types.ts and the container client's one in container-runtime/clients/container/types.ts, which adds log.

Expected

Option types declare optional fields as optional, with the default documented on each field, and methods accept the type directly.

Where

  • packages/testcontainers/src/test-container.ts
  • packages/testcontainers/src/types.ts
  • packages/testcontainers/src/container-runtime/clients/compose/types.ts

Notes

  • Loosening the field types is compatible for callers. Code that reads a StopOptions value and relies on the fields being required would need a change.

Dependencies

  • Nothing blocks this. It can start now.
Lenguaje dominante
TypeScript
Estrellas
2.6k
Forks
274
Merge medio
1 d 14 h
PR fusionados (30 d)
44

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de testcontainers/testcontainers-node

Todos los issues de testcontainers/testcontainers-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.