GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 18:41:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Addon-docs: Fail with debuggable error on non-string description

Browse Source
This commit is contained in:
Michael Shilman 2019-08-01 16:53:43 +08:00
parent 18abecafd2
commit a2bd784400
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
addons/docs/src/blocks/Description.tsx
View File

@ -20,11 +20,20 @@ interface DescriptionProps {
markdown?: string;
}
const str = (o: any) => (typeof o === 'string' ? o : '');
const str = (o: any) => {
if (!o) {
return '';
}
if (typeof o === 'string') {
return o as string;
}
throw new Error(`Description: expected string, got: ${JSON.stringify(o)}`);
};
const getNotes = (notes?: Notes) => notes && (str(notes) || str(notes.markdown) || str(notes.text));
const getNotes = (notes?: Notes) =>
notes && (typeof notes === 'string' ? notes : str(notes.markdown) || str(notes.text));
const getInfo = (info?: Info) => info && (str(info) || str(info.text));
const getInfo = (info?: Info) => info && (typeof info === 'string' ? info : str(info.text));
const getDocgen = (component?: Component) =>
component && component.__docgenInfo && str(component.__docgenInfo.description);