Field To Input

Получите значение поля, обработайте его и передайте в другое поле или директиву — всё в рамках одной операции.

Передайте значение поля field как входные данные в другое поле с помощью $__field, а в директиву — с помощью field @passOnwards(as: "variableName").

`$__field`

Передаёт значение поля как входные данные в другое поле. Синтаксис для ссылки на значение поля: $ (символ переменной в GraphQL), за которым следуют __ и псевдоним или имя поля.

Например, значение поля excerpt ссылается как $__excerpt, а postTitle: title — как $__postTitle.

Ответ второго поля, в свою очередь, может использоваться как входные данные для ещё одного поля:

{
  posts {
    excerpt
 
    # Referencing previous field with name "excerpt"
    isEmptyExcerpt: _isEmpty(value: $__excerpt)
 
    # Referencing previous field with alias "isEmptyExcerpt"
    isNotEmptyExcerpt: _not(value: $__isEmptyExcerpt)
  }
}

Ответ будет:

{
  "data": {
    "posts": [
      {
        "excerpt": "Some post excerpt",
        "isEmptyExcerpt": false,
        "isNotEmptyExcerpt": true
      },
      {
        "excerpt": "",
        "isEmptyExcerpt": true,
        "isNotEmptyExcerpt": false
      }
    ]
  }
}

# This will fail because the reference to the field must appear after the field, not before
{
  posts {
    isEmptyExcerpt: _isEmpty(value: $__excerpt)
    excerpt
  }
}
 
# This will fail because the reference must be done within the same node
{
  posts {
    excerpt
  }
  isEmptyExcerpt: _isEmpty(value: $__excerpt)
}

На поле нельзя ссылаться из аргумента директивы (для этого используйте @passOnwards):

# This will fail because the reference can be only used as input to a field, not to a directive
{
  posts {
    hasComments
    title @include(if: $__hasComments)
  }
}

`@passOnwards`

Директива @passOnwards делает разрешённое значение поля доступным для последующих директив через динамическую переменную.

В приведённом ниже запросе поле notHasComments формируется путём получения значения поля hasComments и вычисления противоположного значения. Это работает следующим образом:

Значение поля становится доступным через @passOnwards; затем оно может быть передано как входные данные в любую последующую директиву
@applyField принимает входные данные (экспортированные под динамической переменной $postHasComments), применяет к ним глобальное поле not и сохраняет результат обратно в поле

{
  posts {
    id
    hasComments
    notHasComments: hasComments
      @passOnwards(as: "postHasComments")
      @applyField(
        name: "_not"
        arguments: {
          value: $postHasComments
        },
        setResultInResponse: true
      )
  }
}

Это вернёт:

{
  "data": {
    "posts": [
      {
        "id": 1724,
        "hasComments": true,
        "notHasComments": false
      },
      {
        "id": 358,
        "hasComments": false,
        "notHasComments": true
      },
      {
        "id": 555,
        "hasComments": false,
        "notHasComments": true
      }
    ]
  }
}

Можно также получить значение любого разрешённого поля объекта, передав псевдоним или имя поля в аргументе property.

Например, в этом запросе мы обращаемся к разрешённому значению по имени поля id или псевдониму second и экспортируем его через динамическую переменную, чтобы вывести в последующем запросе:

query One {
  id
  second: _echo(value: 2)
    @passOnwards(
      property: "id",
      as: "resolvedFirstValue"
    )
    @exportFrom(
      scopedDynamicVariable: $resolvedFirstValue,
      as: "firstValue"
    )
  third: _echo(value: 3)
    @passOnwards(
      property: "second",
      as: "resolvedSecondValue"
    )
    @exportFrom(
      scopedDynamicVariable: $resolvedSecondValue,
      as: "secondValue"
    )
}
 
query Two @depends(on: "One") {
  firstValue: _echo(value: $firstValue)
  secondValue: _echo(value: $secondValue)
}

Это вернёт:

{
  "data": {
    "id": "root",
    "second": 2,
    "third": 3,
    "firstValue": "root",
    "secondValue": 2
  }
}

Примеры

Если отрывок записи пуст, использовать вместо него заголовок:

{
  posts {
    title
    originalExcerpt: excerpt
    isEmptyExcerpt: _isEmpty(value: $__originalExcerpt)
    excerpt: _if(condition: $__isEmptyExcerpt, then: $__title, else: $__originalExcerpt)
  }
}

Получить данные с внешнего REST-эндпоинта и преобразовать их под свои нужды:

{
  externalData: _sendJSONObjectItemHTTPRequest(input: { url: "https://example.com/rest/some-external-endpoint"} )
  userName: _objectProperty(object: $__externalData, by: { path: "data.user.name" })
  userLastName: _objectProperty(object: $__externalData, by: { path: "data.user.surname" })
}

Это вернёт:

{
  "data": {
    "externalData": {
      "data": {
        "user": {
          "id": 1,
          "name": "Leo",
          "surname": "Loso"
        }
      }
    },
    "userName": "Leo",
    "userLastName": "Loso"
  }
}

Используя директиву @remove для externalData, можно также избежать вывода исходных данных внешнего эндпоинта в ответе:

{
  externalData: _sendJSONObjectItemHTTPRequest(input: { url: "https://example.com/rest/some-external-endpoint" } ) @remove
  userName: _objectProperty(object: $__externalData, by: { path: "data.user.name" })
  userLastName: _objectProperty(object: $__externalData, by: { path: "data.user.surname" })
}

Теперь это вернёт:

{
  "data": {
    "userName": "Leo",
    "userLastName": "Loso"
  }
}

Получить записи для каждого пользователя, в которых упоминается его email:

{
  users {
    email
    posts(filter: { search: $__email }) {
      id
      title
    }
  }
}

Отправить рассылку, задав адреса to и from через поле optionValue:

mutation {
  fromEmail: optionValue(name: "admin_email")
  toEmail: optionValue(name: "subscribers_email_list_recipient_address")
  _sendEmail(
    from: {
      email: $__fromEmail
    }
    to: $__toEmail
    subject: "Weekly summary"
    messageAs: {
      html: "..."
    }
  )
}

Выполнять условные операции на основе значения поля. В этом запросе имена пользователей "Leo" и "Peter" преобразуются в верхний регистр, поскольку они находятся в массиве «особых пользователей», а "Martin" — нет:

query {
  users {
    name
      @passOnwards(as: "userName")
      @applyField(
        name: "_inArray"
        arguments: {
          value: $userName
          array: ["Leo", "John", "Peter"]
        }
        passOnwardsAs: "isSpecialUser"
      )
      @if(
        condition: $isSpecialUser
      )
        @strUpperCase
  }
}

...в результате:

{
  "data": {
    "users": [
      {
        "name": "LEO"
      },
      {
        "name": "Martin"
      },
      {
        "name": "PETER"
      }
    ]
  }
}

​$__field

​@passOnwards

​Примеры

`$__field`

`@passOnwards`

Примеры