Interface ILoadSwaggerDocumentationOptions

Options for loadSwaggerDocumentation() and loadSwaggerDocumentationSync() functions.

interface ILoadSwaggerDocumentationOptions {
    debug?: Nilable<DebugAction>;
    dir: string;
    ext?: Nilable<string>;
}

Properties

debug?: Nilable<DebugAction>

The optional debug action / handler.

dir: string

The root directory of the documentation.

Relative paths will be mapped with the current working directory.

ext?: Nilable<string>

The custom file extension.