The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: ServeConfig

types/src.YamlConfig.ServeConfig

Configuration for mesh start or mesh dev command. Those commands won't be available in programmatic usage.

Table of contents#

Properties#

Properties#

browser#

Optional browser: string | boolean

Path to the browser that will be used by mesh serve to open a playground window in development mode This feature can be disable by passing false (Any of: String, Boolean)

Defined in#

packages/types/src/config.ts:106


cors#

Optional cors: CorsConfig

Defined in#

packages/types/src/config.ts:79


customServerHandler#

Optional customServerHandler: string

If you want to use a custom GraphQL server, you can pass the path of the code file that exports a custom Mesh Server Handler With a custom server handler, you won't be able to use the features of GraphQL Mesh HTTP Server

Defined in#

packages/types/src/config.ts:111


endpoint#

Optional endpoint: string

Path to GraphQL Endpoint (default: /graphql)

Defined in#

packages/types/src/config.ts:101


fork#

Optional fork: number | boolean

Spawn multiple server instances as node clusters (default: 1) (Any of: Int, Boolean)

Defined in#

packages/types/src/config.ts:70


handlers#

Optional handlers: (WebhookHandler | ExpressHandler)[]

Express/Connect compatible handlers and middlewares extend GraphQL Mesh HTTP Server (Any of: WebhookHandler, ExpressHandler)

Defined in#

packages/types/src/config.ts:83


hostname#

Optional hostname: string

The binding hostname (default: localhost)

Defined in#

packages/types/src/config.ts:78


maxRequestBodySize#

Optional maxRequestBodySize: string | number

Controls the maximum request body size. If this is a number, then the value specifies the number of bytes; if it is a string, the value is passed to the bytes library for parsing. Defaults to '100kb'. (Any of: Int, String)

Defined in#

packages/types/src/config.ts:95


playground#

Optional playground: boolean

Show GraphiQL Playground

Defined in#

packages/types/src/config.ts:91


port#

Optional port: string | number

TCP Port to listen (default: 3000) (Any of: Int, String)

Defined in#

packages/types/src/config.ts:74


sslCredentials#

Optional sslCredentials: HTTPSConfig

Defined in#

packages/types/src/config.ts:97


staticFiles#

Optional staticFiles: string

Path to your static files you want to be served with GraphQL Mesh HTTP Server

Defined in#

packages/types/src/config.ts:87


upload#

Optional upload: UploadOptions

Defined in#

packages/types/src/config.ts:96