shuding/legid

feature request: sync API

Open

#2 创建于 2025年8月16日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)TypeScript (409 star) (4 fork)user submission
enhancementhelp wanted

描述

I like the idea of this library, and I tried using it for a toy app; the challenge I have is that it would be extremely natural to use createId in class constructors, but these cannot be async and using createId(..).then(...) results in type warnings since the result cannot be definitively assigned.

I see you are building the key functionality on top of crypto.subtle and I imagine its not easy to find a work-around. Also, usually I am happy to use async APIs, but in this case its challenging.

贡献者指南

技术栈
typescriptnodejs
领域
developer experienceapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic TypeScriptUnderstanding of async/sync patterns
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Investigate the current implementation of createId in the repository (likely in src/index.ts or similar). The issue requests a synchronous version because async cannot be used in constructors. Research alternatives to crypto.subtle that are synchronous, such as crypto.getRandomValues in browsers and Node.js crypto.randomBytes (synchronous version). Determine if a sync wrapper can be added without breaking existing async API. Check if there are any comments from maintainers in the issue discussion that provide hints.