`usePayloadFormatter`

Package name	Weekly Downloads	Version	License	Updated
`@envelop/core`				Oct 27th, 2022

Installation

yarn add @envelop/core

`usePayloadFormatter`

Allow you to format/modify execution result payload before returning it to your consumer.

The second argument executionArgs provides additional information for your formatter. It consists of contextValue, variableValues, document, operationName, and other properties.

import { envelop, usePayloadFormatter, useEngine } from '@envelop/core'
import { parse, validate, execute, subscribe } from 'graphql'
 
const getEnveloped = envelop({
  plugins: [
    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
    usePayloadFormatter((result, executionArgs) => {
      // Return a modified result here,
      // Or `false`y value to keep it as-is.
    })
    // ... other plugins ...
  ]
})