ResolveAsDefinition | Vulcan NPM

Index

addOriginalField: boolean

Whether keeping the field or not

example: if field is "userId" and resolved field is "user", set to true to keep "userId" in the document

arguments: string

Graphql arguments of the resolver, as comma separated string, if it takes some params TODO: not sure if this, or an array of "name, type"?

example: arguments: "foobar: string,hello: string" resolver: async (document, {foobar, hello}, context, info) => {...}

description: string

Graphql description (helper text in your graphql schema)

fieldName: string

Resolved field name

example

if field is "userId", resolved fieldName should be "user"

TODO: it as not mandatory in earlier versions of Vulcan?

resolver: QueryResolver<any>

The resolver function

NOTE: your function will be wrapped with a permission checker, based on the field "canRead" permissions

type: string

Alias for typeName

typeName: string

Return type of the resolver

NOTE: it's an alias for "type"