Class: SleepingKingStudios::Docs::RegistryQuery

Parent Namespace

SleepingKingStudios::Docs

Defined In

lib/sleeping_king_studios/docs/registry_query.rb

Table Of Contents

• Overview
• Constructor
• Instance Methods
  • class_method_exists?
  • constant_exists?
  • definition_exists?
  • initialize
  • instance_method_exists?

Overview

Checks for the presence of requested data in the YARD registry.

Back To Top

Constructor

#initialize(registry:) => RegistryQuery

Parameters

• registry (Enumerable) — the YARD registry.

Returns

• (RegistryQuery) — a new instance of RegistryQuery

Back To Top

Instance Methods

#class_method_exists?(method_name) => Boolean

Checks if the given class method is defined in the registry.

Parameters

• method_name (String) — the name of the method and defining namespace, if any.

Returns

• (Boolean) — true if the class method exists, otherwise false.

#constant_exists?(constant_name) => Boolean

Checks if the given constant is defined in the registry.

Parameters

• constant_name (String) — the name of the constant and defining namespace, if any.

Returns

• (Boolean) — true if the constant exists, otherwise false.

#definition_exists?(module_name) => Boolean

Checks if the given class or module is defined in the registry.

Parameters

• module_name (String) — the name of the class or module and defining namespace, if any.

Returns

• (Boolean) — true if the class or module exists, otherwise false.

#instance_method_exists?(method_name) => Boolean

Checks if the given instance method is defined in the registry.

Parameters

• method_name (String) — the name of the method and defining namespace, if any.

Returns

• (Boolean) — true if the instance method exists, otherwise false.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs