Module: Alba::Resource::_ClassMethods

Included in:
ClassMethods, _ResourceClass
Defined in:
sig/alba/resource.rbs

Instance Method Summary collapse

Instance Method Details

#assign_attributes ⇒ void

This method returns an undefined value.

Parameters:

  • (Array[Symbol | String])
  • (instance_proc, Symbol, nil) 


28
 
# File 'sig/alba/resource.rbs', line 28

def assign_attributes: (Array[Symbol | String], instance_proc | Symbol | nil) -> void

#assign_attributes_with_types ⇒ void

This method returns an undefined value.

Parameters:

  • (Hash[Symbol | String, untyped])
  • (instance_proc, Symbol, nil) 


29
 
# File 'sig/alba/resource.rbs', line 29

def assign_attributes_with_types: (Hash[Symbol | String, untyped], instance_proc | Symbol | nil) ?{ (untyped) [self: InstanceMethods] -> untyped } -> void

#association ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, String)
  • (instance_proc, nil)
  • resource: (Class, Proc, String, Symbol, nil)
  • serializer: (Class, Proc, String, Symbol, nil)
  • source: (Proc, nil)
  • key: (key_type)
  • with_traits: (Symbol, Array[Symbol], nil)
  • params: (generic_hash)
  • (Object) 


31
 
# File 'sig/alba/resource.rbs', line 31

def association: (Symbol | String, ?instance_proc?, ?resource: (Class | Proc | String | Symbol)?, ?serializer: (Class | Proc | String | Symbol)?, ?source: Proc?, ?key: key_type, ?with_traits: Symbol | Array[Symbol] | nil, ?params: generic_hash, **untyped) ?{ () [self: singleton(Resource)] -> void } -> (Alba::Association | Alba::ConditionalAttribute)

#attribute ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, String, nil)
  • if: (instance_proc, Symbol, nil)
  • (Object) 


30
 
# File 'sig/alba/resource.rbs', line 30

def attribute: (?Symbol | String | nil, ?if: instance_proc | Symbol | nil, **untyped) ?{ (untyped) [self: InstanceMethods] -> untyped } -> void

#attributes ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, String)
  • if: (instance_proc, Symbol, nil)
  • (Object) 


27
 
# File 'sig/alba/resource.rbs', line 27

def attributes: (*(Symbol | String), ?if: instance_proc | Symbol | nil, **untyped) -> void

#collection_key ⇒ Symbol

Parameters:

  • (Symbol, String)

Returns:

  • (Symbol) 


47
 
# File 'sig/alba/resource.rbs', line 47

def collection_key: (Symbol | String) -> Symbol

#helper ⇒ void

This method returns an undefined value.

Parameters:



51
 
# File 'sig/alba/resource.rbs', line 51

def helper: (?Module) ?{ (Module) [self: Module] -> untyped } -> Module

#inherited ⇒ void

This method returns an undefined value.

Parameters:



26
 
# File 'sig/alba/resource.rbs', line 26

def inherited: (Class) -> void

#layout ⇒ Alba::Layout

Parameters:

  • file: (String, nil)
  • inline: (Proc, nil)

Returns:



44
 
# File 'sig/alba/resource.rbs', line 44

def layout: (?file: String?, ?inline: Proc?) -> Alba::Layout

#meta ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, nil) 


43
 
# File 'sig/alba/resource.rbs', line 43

def meta: (?Symbol?) ?{ () [self: InstanceMethods] -> generic_hash } -> [Symbol?, metadata_proc?]

#method_added ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol) 


25
 
# File 'sig/alba/resource.rbs', line 25

def method_added: (Symbol) -> void

#nested_attribute ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, String)
  • (Object) 


37
 
# File 'sig/alba/resource.rbs', line 37

def nested_attribute: (Symbol | String, **untyped) ?{ () [self: singleton(Resource)] -> void } -> (Alba::ConditionalAttribute | Alba::NestedAttribute)

#nesting ⇒ String?

Returns:

  • (String, nil) 


36
 
# File 'sig/alba/resource.rbs', line 36

def nesting: () -> String?

#on_error ⇒ void

This method returns an undefined value.

Parameters:

  • handler (?( :raise | :ignore | :nullify | nil)) 


48
 
# File 'sig/alba/resource.rbs', line 48

def on_error: (?( :raise | :ignore | :nullify | nil) handler) ?{ (*untyped) [self: InstanceMethods] -> untyped } -> (Proc | :raise | :ignore | :nullify)?

#on_nil ⇒ void

This method returns an undefined value.



50
 
# File 'sig/alba/resource.rbs', line 50

def on_nil: () ?{ (*untyped) [self: InstanceMethods] -> untyped } -> instance_proc?

#prefer_object_method! ⇒ Symbol

Returns:

  • (Symbol) 


53
 
# File 'sig/alba/resource.rbs', line 53

def prefer_object_method!: () -> Symbol

#prefer_resource_method! ⇒ Symbol

Returns:

  • (Symbol) 


52
 
# File 'sig/alba/resource.rbs', line 52

def prefer_resource_method!: () -> Symbol

#root_key ⇒ Symbol?

Parameters:

  • (Symbol, String)
  • (Symbol, String, nil)

Returns:

  • (Symbol, nil) 


40
 
# File 'sig/alba/resource.rbs', line 40

def root_key: (Symbol | String, ?Symbol | String | nil) -> Symbol?

#root_key! ⇒ class_key_type

Returns:

  • (class_key_type) 


42
 
# File 'sig/alba/resource.rbs', line 42

def root_key!: () -> class_key_type

#root_key_for_collection ⇒ Symbol

Parameters:

  • (Symbol, String)

Returns:

  • (Symbol) 


41
 
# File 'sig/alba/resource.rbs', line 41

def root_key_for_collection: (Symbol | String) -> Symbol

#trait ⇒ void

This method returns an undefined value.

Parameters:

  • (Symbol, String) 


39
 
# File 'sig/alba/resource.rbs', line 39

def trait: (Symbol | String) ?{ () [self: singleton(Resource)] -> void } -> Proc

#transform_keys ⇒ Boolean

Parameters:

  • (Symbol, String)
  • root: (Boolean)
  • cascade: (Boolean)

Returns:

  • (Boolean) 


45
 
# File 'sig/alba/resource.rbs', line 45

def transform_keys: (Symbol | String, ?root: bool, ?cascade: bool) -> bool

#transform_keys! ⇒ Object

Parameters:

  • (Symbol, String)

Returns:

  • (Object) 


46
 
# File 'sig/alba/resource.rbs', line 46

def transform_keys!: (Symbol | String) -> untyped

#validated_error_handler ⇒ :raise, ...

Parameters:

  • handler (:raise, :ignore, :nullify, nil)

Returns:

  • (:raise, :ignore, :nullify, nil) 


49
 
# File 'sig/alba/resource.rbs', line 49

def validated_error_handler: ((:raise | :ignore | :nullify | nil) handler) -> (:raise | :ignore | :nullify)?