ScalarFieldToObjectFieldRewriter | graphql-query-rewriter

Rewriter which nests a scalar field inside of a new output object ex: change from field { subField } to field { subField { objectfield } }

Hierarchy

Rewriter
- ScalarFieldToObjectFieldRewriter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScalarFieldToObjectFieldRewriter(options: ScalarFieldToObjectFieldRewriterOpts): ScalarFieldToObjectFieldRewriter

Overrides Rewriter.constructor
- Defined in rewriters/ScalarFieldToObjectFieldRewriter.ts:14
Parameters
- options: ScalarFieldToObjectFieldRewriterOpts
Returns ScalarFieldToObjectFieldRewriter

Properties

Protected Optional fieldName

fieldName: undefined | string

Protected Optional matchConditions

matchConditions: matchCondition[]

Protected objectFieldName

objectFieldName: string

Protected rootTypes

rootTypes: RootType[] = ['query', 'mutation', 'fragment']

Methods

Protected extractReponseElement

extractReponseElement(response: any, key: string, index?: undefined | number): any

Inherited from Rewriter.extractReponseElement
- Defined in rewriters/Rewriter.ts:84
Parameters
- response: any
- key: string
- Optional index: undefined | number
Returns any

matches

matches(nodeAndVars: NodeAndVarDefs, parents: ASTNode[]): boolean

Overrides Rewriter.matches
- Defined in rewriters/ScalarFieldToObjectFieldRewriter.ts:21
Parameters
- nodeAndVars: NodeAndVarDefs
- parents: ASTNode[]
Returns boolean

rewriteQuery

rewriteQuery(nodeAndVarDefs: NodeAndVarDefs): NodeAndVarDefs

Overrides Rewriter.rewriteQuery
- Defined in rewriters/ScalarFieldToObjectFieldRewriter.ts:29
Parameters
- nodeAndVarDefs: NodeAndVarDefs
Returns NodeAndVarDefs

rewriteResponse

rewriteResponse(response: any, key: string, index?: undefined | number): any

Overrides Rewriter.rewriteResponse
- Defined in rewriters/ScalarFieldToObjectFieldRewriter.ts:51
Parameters
- response: any
- key: string
- Optional index: undefined | number
Returns any

Protected rewriteResponseElement

rewriteResponseElement(response: any, newElement: any, key: string, index?: undefined | number): any

Inherited from Rewriter.rewriteResponseElement
- Defined in rewriters/Rewriter.ts:103
Parameters
- response: any
- newElement: any
- key: string
- Optional index: undefined | number
Returns any

rewriteVariables

rewriteVariables(nodeAndVarDefs: NodeAndVarDefs, variables: Variables): Variables

Inherited from Rewriter.rewriteVariables
- Defined in rewriters/Rewriter.ts:69
Parameters
- nodeAndVarDefs: NodeAndVarDefs
- variables: Variables
Returns Variables

Generated using TypeDoc