UUID

GitHub

UUID param representing universally unique identifier values.

Example: Basic usage

param.type # => :uuid
param.scalar? # => true
param.uuid? # => true

Example: Capabilities

param.formattable? # => false

Example: Enum

if param.enum?
  param.enum # => ["550e8400-e29b-41d4-a716-446655440000"]
  param.enum_reference? # => false
end

Instance Methods

#array?

#array?

GitHub

Whether this param is an array.

Returns

Boolean

---

#binary?

#binary?

GitHub

Whether this param is binary data.

Returns

Boolean

---

#boolean?

#boolean?

GitHub

Whether this param is a boolean.

Returns

Boolean

---

#boundable?

#boundable?

GitHub

Whether this param is boundable.

Returns

Boolean

---

#date?

#date?

GitHub

Whether this param is a date.

Returns

Boolean

---

#datetime?

#datetime?

GitHub

Whether this param is a datetime.

Returns

Boolean

---

#decimal?

#decimal?

GitHub

Whether this param is a decimal.

Returns

Boolean

---

#default

#default

GitHub

The default for this param.

Returns

Object, nil

---

#default?

#default?

GitHub

Whether this param has a default.

Returns

Boolean

---

#deprecated?

#deprecated?

GitHub

Whether this param is deprecated.

Returns

Boolean

---

#description

#description

GitHub

The description for this param.

Returns

String, nil

---

#enum

#enum

GitHub

The enum for this param.

Returns

Array<String>, Symbol, nil

---

#enum?

#enum?

GitHub

Whether this param has an enum.

Returns

Boolean

---

#enum_reference?

#enum_reference?

GitHub

Whether this param is an enum reference.

Returns

Boolean

---

#example

#example

GitHub

The example for this param.

Returns

Object, nil

---

#formattable?

#formattable?

GitHub

Whether this param is formattable.

Returns

Boolean

---

#integer?

#integer?

GitHub

Whether this param is an integer.

Returns

Boolean

---

#literal?

#literal?

GitHub

Whether this param is a literal.

Returns

Boolean

---

#nullable?

#nullable?

GitHub

Whether this param is nullable.

Returns

Boolean

---

#number?

#number?

GitHub

Whether this param is a number.

Returns

Boolean

---

#numeric?

#numeric?

GitHub

Whether this param is numeric.

Returns

Boolean

---

#object?

#object?

GitHub

Whether this param is an object.

Returns

Boolean

---

#optional?

#optional?

GitHub

Whether this param is optional.

Returns

Boolean

---

#partial?

#partial?

GitHub

Whether this param is partial.

Returns

Boolean

---

#reference?

#reference?

GitHub

Whether this param is a reference.

Returns

Boolean

---

#scalar?

#scalar?

GitHub

Whether this param is scalar.

Returns

Boolean

---

#string?

#string?

GitHub

Whether this param is a string.

Returns

Boolean

---

#tag

#tag

GitHub

The tag for this param.

Returns

String, nil

---

#time?

#time?

GitHub

Whether this param is a time.

Returns

Boolean

---

#to_h

#to_h

GitHub

Converts this param to a hash.

Returns

Hash

---

#type

#type

GitHub

The type for this param.

Returns

Symbol

---

#union?

#union?

GitHub

Whether this param is a union.

Returns

Boolean

---

#unknown?

#unknown?

GitHub

Whether this param is of unknown type.

Returns

Boolean

---

#uuid?

#uuid?

GitHub

Whether this param is a UUID.

Returns

Boolean

---