QueryBuilder
Defined in: builder/query.ts:6
The basis for the Mutation and Query builders.
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”_TInput
Section titled “_TInput”_TInput = any
_TOutput
Section titled “_TOutput”_TOutput = any
_TCurrent
Section titled “_TCurrent”_TCurrent = ReadAppInstance
_TContext
Section titled “_TContext”_TContext = ReadRuntimeInstance
Properties
Section titled “Properties”
readonlyinput:InputBuilder
Defined in: builder/query.ts:8
output
Section titled “output”
readonlyoutput:OutputBuilder
Defined in: builder/query.ts:9
readonlyprn:string
Defined in: builder/index.ts:32
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addGrant()
Section titled “addGrant()”addGrant(
role):OperationGrant
Defined in: builder/operation.ts:14
Grants the App Role access to this operation (Mutation or Query). Note that inside the mutation access to data may be limited by other roles. This is simply saying “this role can access this operation at all”.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”setDescription()
Section titled “setDescription()”setDescription(
description):this
Defined in: builder/index.ts:33
Parameters
Section titled “Parameters”description
Section titled “description”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BaseOperationBuilder.setDescription
toDefinition()
Section titled “toDefinition()”toDefinition():
QueryDefinition
Defined in: builder/query.ts:10