Class: SimpleJsonapi::Node::Document::Collection

Inherits:
Base
  • Object
show all
Defined in:
lib/simple_jsonapi/node/document/collection.rb

Overview

Represents a JSONAPI document whose primary data is a collection of resources.

Instance Attribute Summary collapse

Attributes inherited from Base

#extras, #fields_spec, #include_spec, #root_node, #serializer, #serializer_inferrer, #sort_spec

Instance Method Summary collapse

Methods inherited from Base

#append_included_resource, #as_jsonapi, #included_resource?

Methods inherited from Base

#as_jsonapi

Constructor Details

#initialize(resources:, **options) ⇒ Collection

Returns a new instance of Collection.

Parameters:

  • resources (Array<Object>)
  • options —

    see Base#initialize for additional parameters



10
11
12
13
14
15
 
# File 'lib/simple_jsonapi/node/document/collection.rb', line 10

def initialize(resources:, **options)
  super

  @resources = Array.wrap(resources)
  @data_node = build_child_node(SimpleJsonapi::Node::Data::Collection, resources: @resources)
end

Instance Attribute Details

#resources ⇒ Array<Object> (readonly)

Returns:

  • (Array<Object>) 


5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/simple_jsonapi/node/document/collection.rb', line 5

class Collection < Base
  attr_reader :resources

  # @param resources [Array<Object>]
  # @param options see {Node::Document::Base#initialize} for additional parameters
  def initialize(resources:, **options)
    super

    @resources = Array.wrap(resources)
    @data_node = build_child_node(SimpleJsonapi::Node::Data::Collection, resources: @resources)
  end
end