Skip to content

tooltip.text의 RegionModel 제네릭 타입이 공개 export되지 않음 #51

Description

@Malloc72P

페르소나 리뷰(적대적 검증 통과)에서 정리된 항목입니다.

관점: 사용 개발자(DX) · 구분: 개선 · 심각도: low · 난이도: 낮음

현상

tooltip.text 함수는 (model: RegionModel) => string 시그니처고, 데모는 RegionModel<{ value:number }>처럼 제네릭으로 data를 타이핑한다(use-colorscale.demo.tsx:52). RegionModel은 index.ts에서 export되지만(index.ts:5-12) data 슬롯에 들어갈 사용자 데이터 타입을 제네릭으로 지정하는 패턴이 어느 guide.mdx에도 설명되어 있지 않다. tooltip.guide.mdx는 properties만 다룬다.

근거

packages/hyperglobe/src/types/hyperglobe-props.ts:434-437; packages/hyperglobe/src/index.ts:5-12; packages/hyperglobe/src/hooks/use-colorscale.demo.tsx:51-55; tooltip.guide.mdx:42-73

권고

tooltip 가이드에 RegionModel<MyData> 제네릭 사용 예시 한 단락을 추가하고, region.data가 dataMap 항목과 같은 객체임을 명시.

검증 메모

발견의 제목 'RegionModel 제네릭 타입이 공개 export되지 않음'은 부정확/과장. RegionModel 자체는 index.ts:5-12에서 분명히 export되며, 제네릭 파라미터까지 그대로 노출된다(RegionModel<MyData> 사용 가능). 즉 export 누락 문제가 아니라, '제네릭으로 사용자 data 타입을 지정하는 패턴'과 region.data가 dataMap 항목과 동일 객체라는 점이 어떤 guide.mdx에도 문서화돼 있지 않은 '문서 공백' 문제다. detail 본문은 이 점을 올바르게 서술하나 title이 사실관계를 오도하므로 제목을 '문서화 누락'으로 정정해야 한다. 추가로, tooltip.text 시그니처의 RegionModel은 비제네릭(기본 DATA_TYPE=any)이라 guide 예시(region.properties 사용)에서는 data 자동완성이 애초에 작동하지 않는다는 점도 가이드에 명시하면 좋다.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomersreview페르소나 리뷰에서 도출된 항목

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions