commonMain.com.apollographql.apollo.api.OperationDataExtensions.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of apollo-api-jvm Show documentation

Apollo GraphQL API classes

There is a newer version: 4.0.0

@file:JvmName("OperationDataJsonSerializer")

package com.apollographql.apollo.api

import com.apollographql.apollo.api.ScalarTypeAdapters.Companion.DEFAULT
import com.apollographql.apollo.api.internal.SimpleResponseWriter
import okio.IOException
import kotlin.jvm.JvmName
import kotlin.jvm.JvmOverloads

/**
 * Serializes GraphQL operation response data into its equivalent Json representation.
 * For example:
 * {@code
 *    {
 *      "data": {
 *        "allPlanets": {
 *          "__typename": "PlanetsConnection",
 *          "planets": [
 *            {
 *              "__typename": "Planet",
 *              "name": "Tatooine",
 *              "surfaceWater": 1.0
 *            }
 *          ]
 *        }
 *      }
 *    }
 * }
 *
 * @param indent the indentation string to be repeated for each level of indentation in the encoded document. Must be a string
 * containing only whitespace. If [indent] is an empty String the encoded document will be compact. Otherwise the encoded
 * document will be more human-readable.
 * @param scalarTypeAdapters configured instance of custom GraphQL scalar type adapters. Default adapters are used if this
 * param is not provided.
 */
@JvmName("serialize")
@JvmOverloads
fun Operation.Data.toJson(indent: String = "", scalarTypeAdapters: ScalarTypeAdapters = DEFAULT): String {
  return try {
    SimpleResponseWriter(scalarTypeAdapters).let { writer ->
      marshaller().marshal(writer)
      writer.toJson(indent)
    }
  } catch (e: IOException) {
    throw IllegalStateException(e)
  }
}