Class: JSONAPI::Document::Resource::Attributes::Attribute

Inherits:

NameValuePair

• Object
• Item
• NameValuePair
• JSONAPI::Document::Resource::Attributes::Attribute

Defined in:

lib/easy/jsonapi/document/resource/attributes/attribute.rb

Overview

An individual attribute in a JSON:API Attributes object

Instance Attribute Summary

• #field ⇒ Object readonly

  Returns the value of attribute field.

Attributes inherited from Item

#item

Instance Method Summary

• #initialize(name, value, type: String) ⇒ Attribute constructor

  A new instance of Attribute.

Methods inherited from NameValuePair

#name, #name=, #to_h, #to_s, #value, #value=

Methods inherited from Item

#to_h, #to_s

Constructor Details

#initialize(name, value, type: String) ⇒ Attribute

Returns a new instance of Attribute.

Parameters:

• name (String) —

  The name of an attribute

• value (String) —

  The value of an attribute

• type (Any) (defaults to: String) —

  The type of an attribute value

# File 'lib/easy/jsonapi/document/resource/attributes/attribute.rb', line 20

def initialize(name, value, type: String)
  @field = JSONAPI::Field.new(name, type: type)
  super(name, value)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class JSONAPI::Item

Instance Attribute Details

#field ⇒ Object (readonly)

Returns the value of attribute field.

# File 'lib/easy/jsonapi/document/resource/attributes/attribute.rb', line 15

def field
  @field
end