Declare option fields as optional instead of wrapping the types in `Partial`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 77/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, node.js, typescript
调研方向
阅读 packages/testcontainers/src/types.ts、packages/testcontainers/src/compose-runtime/clients/compose/types.ts 和 packages/testcontainers/src/testcontainers.ts 中的选项声明和方法签名。还要比较公开的 ExecOptions 类型与客户端的 ExecOptions 类型，包括客户端的 log 字段。完成标准是：选项字段将其默认值标注为可选，方法直接接受这些类型，并且受影响的调用方和类型保持一致。
由索引模型根据 Issue 内容生成。
描述
What happens
Option types are declared with every field required, and each method then accepts Partial<...> and fills in defaults:
StopOptionsinstop(options?: Partial<StopOptions>)RestartOptionsinrestart(options?: Partial<RestartOptions>)ExecOptionsinexec(command, opts?: Partial<ExecOptions>)ComposeDownOptionsindown(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.tspackages/testcontainers/src/types.tspackages/testcontainers/src/container-runtime/clients/compose/types.ts
Notes
- Loosening the field types is compatible for callers. Code that reads a
StopOptionsvalue and relies on the fields being required would need a change.
Dependencies
- Nothing blocks this. It can start now.
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 274
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 44
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
testcontainers/testcontainers-node 的其他 Issue
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 74/100
testcontainers/testcontainers-node#1539 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 82/100
testcontainers/testcontainers-node#1533 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 76/100
testcontainers/testcontainers-node#1529 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 78/100
testcontainers/testcontainers-node#1528 ·
维护者通常 1 天内回复
-
bug patch
难度 2/5 1-3 小时 新手友好度 79/100
testcontainers/testcontainers-node#1526 ·
维护者通常 1 天内回复
查看 testcontainers/testcontainers-node 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
status:approved type:bug
难度 1/5 1 小时以内 新手友好度 70/100
维护者通常 1 天内回复
-
stage:4
难度 2/5 1-3 小时 新手友好度 65/100
ilan-pinto/roaring-lions#598 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
Frontmatter next to `src:` is applied to every imported slide, not only the first (undocumented)未关闭
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复