Skip to content

Add optional space prop for JSON.stringify #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Eyas merged 3 commits into from
Apr 6, 2020
Merged

Add optional space prop for JSON.stringify #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae050b4
Add optional space prop to be passed to JSON.stringify
ntucakovic Apr 6, 2020
7e4d9d7
Add space prop to @example doc
ntucakovic Apr 6, 2020
065075b
Describe space parameter and link to stringify method
ntucakovic Apr 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/json-ld.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,21 @@ import { Thing, WithContext } from "schema-dts";
* },
* knowsAbout: ["Compilers", "Computer Science"]
* }}
* space={2}
* />
* ```
*/
export class JsonLd<T extends Thing> extends React.Component<{
item: WithContext<T>;
/** Adds indentation, white space, and line break characters to JSON-LD output. {@link JSON.stringify} */
space?: string | number;
Copy link
Collaborator

@Eyas Eyas Apr 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you as a jsdoc above this line?

Copy link
Contributor Author

@ntucakovic ntucakovic Apr 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just pushed a commit, is that what you had in mind or?

Copy link
Collaborator

@Eyas Eyas Apr 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad for not elaborating: you can put inline JSDocs above a type declaration (i.e. right above "space:") describing it, and it shows up in IDEs etc when someone's looking at props or seeing the autocomplete for space

Copy link
Contributor Author

@ntucakovic ntucakovic Apr 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

string | number is used as type declaration here instead of JSDoc, no? I don't think we can write JSDoc in inline interface declaration like in this case. IDE is complaining and TS won't compile. Can you check?

Copy link
Collaborator

@Eyas Eyas Apr 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's what I mean:

image

image

}> {
render() {
return (
<script
type="application/ld+json"
dangerouslySetInnerHTML={{
__html: JSON.stringify(this.props.item, safeJsonLdReplacer)
__html: JSON.stringify(this.props.item, safeJsonLdReplacer, this.props.space)
}}
/>
);
Expand Down