Skip to content

Commit

Permalink
more jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bracesproul committed Apr 23, 2024
1 parent 95589b3 commit 31d35d8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions js/src/schemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,9 @@ export interface FeedbackCategory {
export interface FeedbackConfig {
/**
* The type of feedback.
* - "continuous": Feedback with a continuous numeric.
* - "categorical": Feedback with a categorical value (classes)
* - "freeform": Feedback with a freeform text value (notes).
*/
type: "continuous" | "categorical" | "freeform";

Expand All @@ -329,6 +332,9 @@ export interface FeedbackConfig {
max?: number | null;

/**
* The categories for categorical feedback.
* Each category can be a string or an object with additional properties.
*
* If feedback is categorical, this defines the valid categories the server will accept.
* Not applicable to continuous or freeform feedback types.
*/
Expand Down

0 comments on commit 31d35d8

Please sign in to comment.