Sha256: baa714c110a1478a4f31d52dce80d355f32e8242ac1968c00f6d2c7b1e087979

Contents?: true

Size: 891 Bytes

Versions: 44

Compression:

Stored size: 891 Bytes

Contents

# frozen_string_literal: true

module GraphQL
  class Schema
    class Member
      module HasDeprecationReason
        # @return [String, nil] Explains why this member was deprecated (if present, this will be marked deprecated in introspection)
        def deprecation_reason
          dir = self.directives.find { |d| d.is_a?(GraphQL::Schema::Directive::Deprecated) }
          dir && dir.arguments[:reason] # rubocop:disable Development/ContextIsPassedCop -- definition-related
        end

        # Set the deprecation reason for this member, or remove it by assigning `nil`
        # @param text [String, nil]
        def deprecation_reason=(text)
          if text.nil?
            remove_directive(GraphQL::Schema::Directive::Deprecated)
          else
            directive(GraphQL::Schema::Directive::Deprecated, reason: text)
          end
        end
      end
    end
  end
end

Version data entries

44 entries across 44 versions & 2 rubygems

Version Path
graphql-1.13.23 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.22 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.21 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.20 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.17.2 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.17.1 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.17 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.19 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.18 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.16 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.17 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.15 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.14 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.16 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.13 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.12 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.15 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-2.0.11 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.14 lib/graphql/schema/member/has_deprecation_reason.rb
graphql-1.13.13 lib/graphql/schema/member/has_deprecation_reason.rb