Class: HakumiComponents::Documentation::Member

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/hakumi_components/documentation/models.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, description: nil, type: nil, default_value: nil, required: nil, values: nil, example: nil, returns: nil, detail: nil) ⇒ Member

Returns a new instance of Member.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/hakumi_components/documentation/models.rb', line 34

def initialize(
  name:,
  description: nil,
  type: nil,
  default_value: nil,
  required: nil,
  values: nil,
  example: nil,
  returns: nil,
  detail: nil
)
  @name = name
  @description = description
  @type = type
  @default_value = default_value
  @required = required
  @values = values
  @example = example
  @returns = returns
  @detail = detail
end

Instance Attribute Details

#default_value ⇒ Object (readonly)

Returns the value of attribute default_value.



66
67
68
 
# File 'lib/hakumi_components/documentation/models.rb', line 66

def default_value
  @default_value
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



60
61
62
 
# File 'lib/hakumi_components/documentation/models.rb', line 60

def description
  @description
end

#detail ⇒ Object (readonly)

Returns the value of attribute detail.



81
82
83
 
# File 'lib/hakumi_components/documentation/models.rb', line 81

def detail
  @detail
end

#example ⇒ Object (readonly)

Returns the value of attribute example.



75
76
77
 
# File 'lib/hakumi_components/documentation/models.rb', line 75

def example
  @example
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



57
58
59
 
# File 'lib/hakumi_components/documentation/models.rb', line 57

def name
  @name
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



69
70
71
 
# File 'lib/hakumi_components/documentation/models.rb', line 69

def required
  @required
end

#returns ⇒ Object (readonly)

Returns the value of attribute returns.



78
79
80
 
# File 'lib/hakumi_components/documentation/models.rb', line 78

def returns
  @returns
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



63
64
65
 
# File 'lib/hakumi_components/documentation/models.rb', line 63

def type
  @type
end

#values ⇒ Object (readonly)

Returns the value of attribute values.



72
73
74
 
# File 'lib/hakumi_components/documentation/models.rb', line 72

def values
  @values
end

Instance Method Details

#to_h ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/hakumi_components/documentation/models.rb', line 84

def to_h
  {
    "name" => @name,
    "description" => @description,
    "type" => @type,
    "default" => @default_value,
    "required" => @required,
    "values" => @values,
    "example" => @example,
    "returns" => @returns,
    "detail" => @detail
  }
end