Make LoroMap.entries() generic to support branded string types

未关闭
#889 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
typescript
领域
api

调研方向

首先定位 LoroMap.entries() 的 TypeScript 定义和实现,并检查 LoroMap 如何声明其键类型。使用带 brand 的字符串键添加类型级检查,并验证 entries() 在不使用 casts 的情况下保留键类型。当带 brand 的键示例通过类型检查,且现有的 entries() 行为仍保持兼容时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

Problem

The entries() method on LoroMap currently has a fixed return type:

entries(): ([string, Value | Container])[];

This makes it difficult to use with branded/nominal string types for keys. Many TypeScript codebases use branded types for IDs to provide additional type-level safety:

type SeminarId = string & { readonly _brand: unique symbol };
type RoomId = string & { readonly _brand: unique symbol };

// When iterating over a map with SeminarId keys, we lose the brand information
const map: LoroMap<SeminarId, SomeValue> = ...;
const entries = map.entries(); // Returns [string, Value | Container][] - SeminarId brand is lost

Proposed Solution

Make the entries() method generic to preserve the key type:

entries(): ([K, Value | Container])[];
// or if LoroMap already has a key type parameter:
entries(): ([KeyType, Value | Container])[];

This would allow branded string types to flow through correctly:

const entries = map.entries(); // Returns [SeminarId, Value | Container][]

Use Case

We're building a planning system where we have multiple entity types (seminars, rooms, bookings, etc.) each with their own branded ID type. When iterating over CRDT maps, we currently lose this type information and have to cast manually, which defeats the purpose of having branded types for type safety.

Environment

  • loro-crdt version: 1.8.8
  • TypeScript 5.9

Thank you for considering this enhancement!

主要语言
Rust
星标
6.3k
派生
205
平均合并
3 天 18 小时
30 天内合并 PR
45

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

loro-dev/loro 的其他 Issue

查看 loro-dev/loro 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。