Add documentation for IRequestHeader (#20673)

jatgarg · Jatin Garg · web-flow · commit 558c48d35aaf · 2024-04-18T05:51:17.000+05:30
## Description [Task: ](https://dev.azure.com/fluidframework/internal/_workitems/edit/7164) Adding documentation for IRequestheader. --------- Co-authored-by: Jatin Garg <jatingarg@Jatins-MacBook-Pro-2.local>
diff --git a/packages/common/driver-definitions/src/urlResolver.ts b/packages/common/driver-definitions/src/urlResolver.ts
@@ -93,7 +93,11 @@ export interface IDriverHeader {
 }
 
 declare module "@fluidframework/core-interfaces" {
-	// TODO: This interface should be documented. AB#7164
-	// eslint-disable-next-line @typescript-eslint/no-empty-interface, jsdoc/require-jsdoc
+	/**
+	 * Interface to represent headers to include in the container or data store load request.
+	 * For example, caller can use this to pass on various loader options in the container
+	 * load request.
+	 */
+	// eslint-disable-next-line @typescript-eslint/no-empty-interface
 	export interface IRequestHeader extends Partial<IDriverHeader> {}
 }

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,11 @@ export interface IDriverHeader {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`declare module "@fluidframework/core-interfaces" {`
`96`		`- // TODO: This interface should be documented. AB#7164`
`97`		`- // eslint-disable-next-line @typescript-eslint/no-empty-interface, jsdoc/require-jsdoc`
	`96`	`+ /**`
	`97`	`+ * Interface to represent headers to include in the container or data store load request.`
	`98`	`+ * For example, caller can use this to pass on various loader options in the container`
	`99`	`+ * load request.`
	`100`	`+ */`
	`101`	`+ // eslint-disable-next-line @typescript-eslint/no-empty-interface`
`98`	`102`	`export interface IRequestHeader extends Partial<IDriverHeader> {}`
`99`	`103`	`}`