Make LoroMap.entries() generic to support branded string types
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- typescript
- 領域
- api
調査の方向性
まず、LoroMap.entries() の TypeScript 定義と実装を見つけ、LoroMap がキーの型をどのように宣言しているかを確認します。ブランド付き文字列キーを使った型レベルのチェックを追加し、entries() がキャストなしでキーの型を保持することを検証します。ブランド付きキーの例が型チェックを通過し、既存の 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時間
- マージ済み PR(30日)
- 45
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
loro-dev/loro のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
メンテナーはふだん 1 日以内に返信
-
Shallow snapshot root retreats far below the requested frontier when two peers take turns (since 1.16.2)対応中かも @avergin が 1 日前に担当しました。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
storytold/photocraft#15350 ·
メンテナーはふだん 1 日以内に返信
-
area:davinci
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ubugeeei-prod/vize#13167 ·
メンテナーはふだん 1 日以内に返信
-
area:ui enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
transit-audio/transit#738 ·
メンテナーはふだん 1 日以内に返信
-
enhancement good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 91/100
hocinehacherouf/liberarr#78 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信