React中使用DatoCMS StructuredText时如何读取unknown类型Record属性值
报错核心原因
StructuredText组件传入的通用Record类型,带有[prop: string]: unknown的索引签名,TypeScript无法仅通过record.__typename === 'MyblockRecord'的等值判断,自动推导出具体块的字段结构。此时直接读取record.image.responsiveImage这类深层属性,就会因为属性值类型为unknown,触发类型不允许安全访问的报错。
解决方法
1. 方案一:基于类型守卫的类型收窄(推荐,无类型安全损失)
- 按照你在DatoCMS中配置的
Myblock块的实际字段结构,定义对应的TypeScript类型,直接复用项目中Image组件的入参类型,减少重复维护成本:
// 与DatoCMS中Myblock块的配置完全对齐的类型定义 type MyblockRecord = { __typename: 'MyblockRecord' id: string image: { responsiveImage: React.ComponentProps<typeof Image>['data'] } }
- 编写类型守卫函数,让TypeScript在判断通过时自动收窄record的类型:
/** * 类型守卫:校验传入的通用record是否为MyblockRecord类型 */ const isMyblockRecord = (record: Record): record is MyblockRecord => { return record.__typename === 'MyblockRecord' }
- 替换原代码中的判断逻辑,触发类型收窄后即可安全读取对应属性:
<StructuredText data={isFull ? content : null} renderBlock={({ record }) => { // 用类型守卫替换原本的__typename等值判断 if (isMyblockRecord(record) && isFull) { return ( <div style={{ width: '80%', margin: '20px auto' }}> <Image data={record.image.responsiveImage} /> </div> ); } return null; }} />
这种方式完全保留TypeScript的类型检查能力,后续如果块的字段有调整,TS会直接在编译阶段提示不匹配的问题,不会出现运行时的属性读取错误。
2. 方案二:临时类型断言(适合快速调试,不推荐生产环境长期使用)
如果不想单独维护类型定义,可以在读取属性时对record做明确的类型断言,手动告知TS该字段的结构,同样可以消除报错:
<StructuredText data={isFull ? content : null} renderBlock={({ record }) => { if (record.__typename === 'MyblockRecord' && isFull) { // 手动断言record的结构,明确告知TS字段类型 const typedRecord = record as { image: { responsiveImage: React.ComponentProps<typeof Image>['data'] } } return ( <div style={{ width: '80%', margin: '20px auto' }}> <Image data={typedRecord.image.responsiveImage} /> </div> ); } return null; }} />
注意:不要使用
as any绕过类型检查,否则会丢失所有字段的校验能力,当DatoCMS侧的块字段调整时,容易出现线上运行错误。
注意事项
- 自定义的块类型要和DatoCMS控制台配置的字段完全匹配,比如如果image字段是可空的,需要在类型中标记为可选,避免出现“读取空值属性”的TS报错
- 如果项目已经通过DatoCMS的CLI工具自动生成了对应的块类型,可以直接复用生成的
MyblockRecord类型,不需要手动重复定义,减少手动维护的误差
内容的提问来源于stack exchange,提问作者Kamil
相关产品推荐
相关产品推荐

