zoriya/elysia-swagger
1
0
Fork 0
mirror of https://github.com/zoriya/elysia-swagger.git synced 2025-12-06 00:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjusted documentation

Browse Source
This commit is contained in:
John Cudd
2024-01-18 14:29:35 -05:00
parent ee981cf0d2
commit 53c2b13334
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/types.ts
View File

@@ -29,17 +29,20 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
*/
scalarVersion?: string
/**
* Version to use for Scalar cdn bundle
* Custom URL or path to locally hosted Scalar bundle
*
* @default '1.12.5'
* @see https://github.com/scalar/scalar
* Lease blank to use default jsdeliver.net CDN
*
* @default ''
* @example 'https://unpkg.com/@scalar/api-reference@1.13.10/dist/browser/standalone.js'
* @example '/public/standalone.js'
*/
scalarCDN?: string
/**
* Scalar CDN bundle url
* Scalar configuration to customize scalar
*
* @default ''
* @example 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@$1.12.5/dist/browser/standalone.min.js'
* @default '1.12.5'
* @see https://github.com/scalar/scalar
*/
scalarConfig?: ReferenceConfiguration
/**