Version: 1.0

buildGraphbackAPI

Index#

Interfaces#

Type aliases#

Functions#

Type aliases#

GraphbackDataProviderCreator#

Ƭ GraphbackDataProviderCreator: function

Defined in buildGraphbackAPI.ts:57

Type declaration:#

▸ (model: ModelDefinition): GraphbackDataProvider

Parameters:

NameType
modelModelDefinition

GraphbackServiceCreator#

Ƭ GraphbackServiceCreator: function

Defined in buildGraphbackAPI.ts:56

Type declaration:#

▸ (model: ModelDefinition, dataProvider: GraphbackDataProvider): GraphbackCRUDService

Parameters:

NameType
modelModelDefinition
dataProviderGraphbackDataProvider

Functions#

buildGraphbackAPI#

buildGraphbackAPI(model: string | GraphQLSchema, config: GraphbackAPIConfig): GraphbackAPI

Defined in buildGraphbackAPI.ts:113

Creates all of the components needed for the GraphQL server - resolvers, schema and services.

Parameters:

NameTypeDescription
modelstring | GraphQLSchemaData model as a string or GraphQL schema. Used to generate the Graphback API resolvers, services and database
configGraphbackAPIConfig-

Returns: GraphbackAPI

Generated schema, CRUD resolvers and services