@trivia-api/models/dist/mjs/packages/models/src/v2/quiz/index.d.ts

Models for The Trivia API.

import { V2Question } from "../question/index";
/**
 * Quiz as returned by the API.
 *
 * @openapi
 *  components:
 *    schemas:
 *      Quiz:
 *        type: object
 *        properties:
 *          id:
 *            type: string
 *            description: Unique ID for this quiz.
 *          title:
 *            type: string
 *            description: User-friendly title for the quiz.
 *            example: Will's Dinosaur Quiz
 *          questions:
 *            type: array
 *            items:
 *              $ref: '#/components/schemas/V2Question'
 *              description: The questions on this quiz.
 *        required:
 *          - id
 *          - title
 *          - questions
 */
export type V2Quiz = {
    /**
     * Unique ID for this quiz.
     */
    id: string;
    /**
     * User-friendly title for the quiz.
     * @example "Will's Dinosaur Quiz"
     */
    title: string;
    /**
     * The questions on this quiz.
     */
    questions: V2Question[];
};