Skip to content

Commit 080d613

Browse files
committed
docs(middleware): add JSDoc to farcasterHubContext middleware
1 parent 7b42f0c commit 080d613

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

packages/frames.js/src/middleware/farcasterHubContext.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,21 @@ type FramesMessageContext = {
6767
clientProtocol?: ClientProtocolId;
6868
};
6969

70+
/**
71+
* Middleware that extracts and validates Farcaster frame messages.
72+
* Adds the decoded message and client protocol information to the context.
73+
* Only processes POST requests with valid frame action payloads.
74+
*
75+
* @param options - Optional configuration for the Farcaster Hub HTTP URL
76+
* @returns A frames middleware that adds message context
77+
*
78+
* @example
79+
* ```typescript
80+
* const frames = createFrames({
81+
* middleware: [farcasterHubContext()],
82+
* });
83+
* ```
84+
*/
7085
export function farcasterHubContext(
7186
options?: HubHttpUrlOptions
7287
): FramesMiddleware<any, FramesMessageContext> {

0 commit comments

Comments
 (0)