nestjs-redox/src/lib/types.js

This NestJS module enables to auto-generate beautiful API docs using Swagger and Redoc. It supports NestJS 10, ExpressJS and Fastify.

"use strict";
// source: https://github.com/Redocly/redoc/blob/main/docs/config.md
Object.defineProperty(exports, "__esModule", { value: true });
exports.NestJSRedoxOptions = void 0;
class NestJSRedoxOptions {
    constructor(partial) {
        // served path on that the redoc is available
        this.useGlobalPrefix = false;
        this.disableGoogleFont = false;
        /**
         * Enable this if you want to serve your own redoc installation. You have to install redoc as dependency.
         * @default: false
         */
        this.standalone = false;
        /**
         * By default, the swagger JSON file can be downloaded from a Blob URL only. If you need to access the sagger JSON
         * via URL, use this option.
         */
        this.serveAPIDoc = {
            enabled: false,
            filename: 'swagger.json',
        };
        if (partial) {
            Object.assign(this, partial);
        }
    }
}
exports.NestJSRedoxOptions = NestJSRedoxOptions;