Skip to content

Commit eac0b15

Browse files
add missing js doc comment descriptions
1 parent 01db10b commit eac0b15

File tree

5 files changed

+90
-74
lines changed

5 files changed

+90
-74
lines changed

packages/hydrogen-react/src/ExternalVideo.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type {Entries, PartialDeep} from 'type-fest';
33
import {forwardRef, IframeHTMLAttributes} from 'react';
44

55
/**
6-
* The `ExternalVideo` component renders an embedded video for the Storefront API's [ExternalVideo object](https://shopify.dev/api/storefront/reference/products/externalvideo).
6+
* Takes in the same props as a native `<iframe>` element, except for `src`.
77
* @publicDocs
88
*/
99
export interface ExternalVideoBaseProps {

packages/hydrogen-react/src/analytics.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ function sendToShopify(
137137
}
138138

139139
/**
140-
* Gathers client browser values commonly used for analytics.
140+
* If executed on server, this method will return empty string for each field.
141141
* @publicDocs
142142
*/
143143
export function getClientBrowserParameters(): ClientBrowserParameters {

packages/hydrogen-react/src/parse-metafield.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,7 @@ import {flattenConnection} from './flatten-connection.js';
1313
import {RootASTNode as RichTextRootASTNode} from './RichText.types.js';
1414

1515
/**
16-
* A function that uses `metafield.type` to parse the Metafield's `value` or `reference` or `references` (depending on the `metafield.type`) and places the result in `metafield.parsedValue`
17-
*
18-
* TypeScript developers can use the type `ParsedMetafields` from this package to get the returned object's type correct. For example:
19-
*
20-
* ```
21-
* parseMetafield<ParsedMetafields['boolean']>({type: 'boolean', value: 'false'}
22-
* ```
16+
* Use the `ParsedMetafields` type as the returned type of `parseMetafield(metafield)`
2317
* @publicDocs
2418
*/
2519
export function parseMetafield<ReturnGeneric>(

0 commit comments

Comments
 (0)