Options for configuring the GraphQL server.
Signature:
export interface GraphqlServerOptions extends Omit<HttpsOptions, "cors">
Extends: Omit<HttpsOptions, "cors">
Properties
| Property | Type | Description |
|---|---|---|
| path | string | The path where the GraphQL server will be served on the Cloud Run function. e.g. https://...run.app/{path} If no path is provided, "graphql" is used as the default. |
| resolvers | GraphqlResolvers | A map of functions that populate data for individual GraphQL schema fields. |
| schema | string | A valid SDL string that represents the GraphQL server's schema. Either schema or schemaFilePath is required. |
| schemaFilePath | string | A relative file path from the Firebase project directory to a valid GraphQL schema. Either schema or schemaFilePath is required. |
dataconnect.GraphqlServerOptions.path
The path where the GraphQL server will be served on the Cloud Run function. e.g. https://...run.app/{path} If no path is provided, "graphql" is used as the default.
Signature:
path?: string;
dataconnect.GraphqlServerOptions.resolvers
A map of functions that populate data for individual GraphQL schema fields.
Signature:
resolvers: GraphqlResolvers;
dataconnect.GraphqlServerOptions.schema
A valid SDL string that represents the GraphQL server's schema. Either schema or schemaFilePath is required.
Signature:
schema?: string;
dataconnect.GraphqlServerOptions.schemaFilePath
A relative file path from the Firebase project directory to a valid GraphQL schema. Either schema or schemaFilePath is required.
Signature:
schemaFilePath?: string;