packages/graphback-core/src/plugin/ModelDefinition
Index#
Type aliases#
Functions#
Type aliases#
FieldDescriptor#
Ƭ FieldDescriptor: object
Defined in packages/graphback-core/src/plugin/ModelDefinition.ts:8
Describe the name and type of primary key
Type declaration:#
name: string
transient? : boolean | undefined
type: string
ModelDefinition#
Ƭ ModelDefinition: object
Defined in packages/graphback-core/src/plugin/ModelDefinition.ts:21
Used to encapsulate configuration for the type
Type declaration:#
crudOptions: GraphbackCRUDGeneratorConfig
fields: ModelFieldMap
graphqlType: GraphQLObjectType
primaryKey: FieldDescriptor
relationships: FieldRelationshipMetadata[]
ModelFieldMap#
Ƭ ModelFieldMap: object
Defined in packages/graphback-core/src/plugin/ModelDefinition.ts:14
Type declaration:#
- [ key: string]: FieldDescriptor
Functions#
getModelByName#
▸ getModelByName(name: string, models: ModelDefinition[]): ModelDefinition | undefined
Defined in packages/graphback-core/src/plugin/ModelDefinition.ts:29
Parameters:
| Name | Type |
|---|---|
name | string |
models | ModelDefinition[] |
Returns: ModelDefinition | undefined