Skip to main content

types_src.yamlconfig.serveconfig

Interface: ServeConfig#

types/src.YamlConfig.ServeConfig

Configuration for mesh serve 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:96


cors#

Optional cors: CorsConfig

Defined in: packages/types/src/config.ts:69


endpoint#

Optional endpoint: string

Path to GraphQL Endpoint (default: /graphql)

Defined in: packages/types/src/config.ts:91


exampleQuery#

Optional exampleQuery: string

Provide an example query or queries for GraphQL Playground The value can be the file path, glob expression for the file paths or the SDL. (.js, .jsx, .graphql, .gql, .ts and .tsx files are supported. But TypeScript support is only available if ts-node is installed and ts-node/register is added under require parameter)

Defined in: packages/types/src/config.ts:68


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:53


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:73


hostname#

Optional hostname: string

The binding hostname (default: localhost)

Defined in: packages/types/src/config.ts:61


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:85


playground#

Optional playground: boolean

Show GraphiQL Playground

Defined in: packages/types/src/config.ts:81


port#

Optional port: string | number

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

Defined in: packages/types/src/config.ts:57


sslCredentials#

Optional sslCredentials: HTTPSConfig

Defined in: packages/types/src/config.ts:87


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:77


upload#

Optional upload: UploadOptions

Defined in: packages/types/src/config.ts:86