Class: Funicular::Router

Inherits:
Object
  • Object
show all
Defined in:
sig/router.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Router

Returns a new instance of Router.

Parameters:

  • container (JS::Element, nil) 


12
 
# File 'sig/router.rbs', line 12

def initialize: (JS::Element? container) -> void

Instance Attribute Details

#current_component ⇒ Component? (readonly)

Returns the value of attribute current_component.

Returns:



7
8
9
 
# File 'sig/router.rbs', line 7

def current_component
  @current_component
end

#current_path ⇒ String? (readonly)

Returns the value of attribute current_path.

Returns:

  • (String, nil) 


8
9
10
 
# File 'sig/router.rbs', line 8

def current_path
  @current_path
end

#route_helpers ⇒ Object (readonly)

Returns the value of attribute route_helpers.

Returns:

  • (Object) 


10
11
12
 
# File 'sig/router.rbs', line 10

def route_helpers
  @route_helpers
end

#routes ⇒ Array[route_definition_t] (readonly)

Returns the value of attribute routes.

Returns:

  • (Array[route_definition_t]) 


6
7
8
 
# File 'sig/router.rbs', line 6

def routes
  @routes
end

#url_helpers ⇒ Module (readonly)

Returns the value of attribute url_helpers.

Returns:

  • (Module) 


9
10
11
 
# File 'sig/router.rbs', line 9

def url_helpers
  @url_helpers
end

Instance Method Details

#add_route ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • component_class (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


18
 
# File 'sig/router.rbs', line 18

def add_route: (String path, singleton(Component) component_class, ?as: String?, ?constraints: route_constraints_t?) -> void

#current_location_path ⇒ String

Returns:

  • (String) 


24
 
# File 'sig/router.rbs', line 24

def current_location_path: () -> String

#delete ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • to: (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


17
 
# File 'sig/router.rbs', line 17

def delete: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void

#get ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • to: (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


13
 
# File 'sig/router.rbs', line 13

def get: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void

#match ⇒ [singleton(Component)?, Hash[Symbol, untyped]]

Parameters:

  • path (String)

Returns:

  • ([singleton(Component)?, Hash[Symbol, untyped]]) 


20
 
# File 'sig/router.rbs', line 20

def match: (String path) -> [singleton(Component)?, Hash[Symbol, untyped]]

#navigate ⇒ void

This method returns an undefined value.

Parameters:

  • path (String) 


23
 
# File 'sig/router.rbs', line 23

def navigate: (String path) -> void

#patch ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • to: (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


16
 
# File 'sig/router.rbs', line 16

def patch: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void

#post ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • to: (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


14
 
# File 'sig/router.rbs', line 14

def post: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void

#put ⇒ void

This method returns an undefined value.

Parameters:

  • path (String)
  • to: (singleton(Component))
  • as: (String, nil)
  • constraints: (route_constraints_t, nil) 


15
 
# File 'sig/router.rbs', line 15

def put: (String path, to: singleton(Component), ?as: String?, ?constraints: route_constraints_t?) -> void

#set_default ⇒ void

This method returns an undefined value.

Parameters:

  • path (String) 


19
 
# File 'sig/router.rbs', line 19

def set_default: (String path) -> void

#start ⇒ void

This method returns an undefined value.

Parameters:

  • hydrate: (Boolean) 


21
 
# File 'sig/router.rbs', line 21

def start: (?hydrate: bool) -> void

#stop ⇒ void

This method returns an undefined value.



22
 
# File 'sig/router.rbs', line 22

def stop: () -> void