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
- browser
- cors
- customServerHandler
- endpoint
- fork
- hostname
- playground
- playgroundTitle
- port
- sslCredentials
- staticFiles
- trustProxy
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 disabled by passing false
(Any of: String, Boolean)
Defined in
packages/types/src/config.ts:105
cors
• Optional
cors: CorsConfig
Defined in
packages/types/src/config.ts:87
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:110
endpoint
• Optional
endpoint: string
Path to GraphQL Endpoint (default: /graphql)
Defined in
packages/types/src/config.ts:100
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:78
hostname
• Optional
hostname: string
The binding hostname (default: localhost
)
Defined in
packages/types/src/config.ts:86
playground
• Optional
playground: boolean
Show GraphiQL Playground
Defined in
packages/types/src/config.ts:95
playgroundTitle
• Optional
playgroundTitle: string
Title of GraphiQL Playground
Defined in
packages/types/src/config.ts:114
port
• Optional
port: string
| number
TCP Port to listen (default: 4000
) (Any of: Int, String)
Defined in
packages/types/src/config.ts:82
sslCredentials
• Optional
sslCredentials: HTTPSConfig
Defined in
packages/types/src/config.ts:96
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:91
trustProxy
• Optional
trustProxy: string
Configure Express Proxy Handling Learn more
Defined in
packages/types/src/config.ts:119