Skip to content

Commit 2b6949f

Browse files
committed
docs: enhance JSDoc for parseFramesWithReports function
1 parent c6fd665 commit 2b6949f

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

packages/frames.js/src/parseFramesWithReports.ts

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,16 @@ type ParseFramesWithReportsOptions = {
3636
};
3737

3838
/**
39-
* Gets all supported frames and validation their respective validation reports.
39+
* Parses HTML content and extracts frame data for all supported frame specifications.
40+
* Returns parsed frames along with validation reports for each specification.
41+
*
42+
* @param options - Configuration options for parsing
43+
* @param options.html - The HTML content to parse
44+
* @param options.frameUrl - URL of the frame
45+
* @param options.fallbackPostUrl - URL to use if frame doesn't specify a post_url
46+
* @param options.fromRequestMethod - Request method used ('GET' or 'POST'), affects validation
47+
* @param options.parseSettings - Optional settings to customize parsing behavior
48+
* @returns Parsed frames for Farcaster, Farcaster v2, and OpenFrames specifications
4049
*/
4150
export async function parseFramesWithReports({
4251
html,
@@ -81,10 +90,10 @@ export async function parseFramesWithReports({
8190
framesVersion,
8291
...(debugImageUrl
8392
? {
84-
framesDebugInfo: {
85-
image: debugImageUrl,
86-
},
87-
}
93+
framesDebugInfo: {
94+
image: debugImageUrl,
95+
},
96+
}
8897
: {}),
8998
};
9099

0 commit comments

Comments
 (0)