Class Frame

Main Frame class

Hierarchy

FrameworkApp
- Frame

Index

Constructors

Properties

Accessors

openapi postman

Methods

build refreshDocs

Constructors

constructor

new Frame(config?: FrameOptions): Frame
Parameters
- Optionalconfig: FrameOptions
Returns Frame
Overrides FrameworkApp.constructor
- Defined in src/index.ts:83

Properties

`Protected`docs

docs: { openapi: OpenAPI; postman: Postman }

Documentation instances

Accessors

openapi

get openapi(): OpenAPI
Get the OpenAPI documentation instance

Returns OpenAPI
- Defined in src/index.ts:72

postman

get postman(): Postman
Get the Postman documentation instance

Returns Postman
- Defined in src/index.ts:79

Methods

build

build<
    T extends
        ServerOptions<typeof IncomingMessage, typeof ServerResponse> = ServerOptions<
        typeof IncomingMessage,
        typeof ServerResponse,
    >,
>(
    options?: T | null,
    mod?: {
        createServer(
            requestListener?: RequestListener<
                typeof IncomingMessage,
                typeof ServerResponse,
            >,
        ): Server;
        createServer(
            options: T,
            requestListener?: RequestListener<
                typeof IncomingMessage,
                typeof ServerResponse,
            >,
        ): Server;
    },
): Server
Build the HTTP server and refresh the docs before returning it
Type Parameters
- T extends ServerOptions<typeof IncomingMessage, typeof ServerResponse> = ServerOptions<typeof IncomingMessage, typeof ServerResponse>
Parameters
- Optionaloptions: T | null
- Optionalmod: {
      createServer(
          requestListener?: RequestListener<
              typeof IncomingMessage,
              typeof ServerResponse,
          >,
      ): Server;
      createServer(
          options: T,
          requestListener?: RequestListener<
              typeof IncomingMessage,
              typeof ServerResponse,
          >,
      ): Server;
  }
Returns Server
Overrides FrameworkApp.build
- Defined in src/index.ts:291

refreshDocs

refreshDocs(): void
Remove all routes related to docs and re-add them

Returns void
- Defined in src/index.ts:281