Class: Cuprum::Cli::Files::Errors::GeneratorError

Parent Namespace

Cuprum::Cli::Files::Errors

Inherited Classes

Cuprum::Error > Object

Defined In

lib/cuprum/cli/files/errors/generator_error.rb

Table Of Contents

• Overview
• Constants
  • TYPE
• Constructor
• Instance Attributes
  • details
  • file_path
  • options
• Instance Methods
  • initialize

Overview

Error returned when an error occurs when calling a generator.

Back To Top

Constants

TYPE

= 'cuprum.cli.files.errors.generator_error'

Short string used to identify the type of error.

Back To Top

Constructor

#initialize(message:, details: nil, file_path: nil, options: {}, **) => GeneratorError

Parameters

• message (String) — message describing the nature of the error.
• details (String) — additional information about the error.
• file_path (String) — the file path passed to the generator.
• options (Hash) — additional options passed to the generator.

Returns

• (GeneratorError) — a new instance of GeneratorError

Back To Top

Instance Attributes

#details => String (readonly)

Returns

• (String) — additional information about the error.

#file_path => String (readonly)

Returns

• (String) — the file path passed to the generator.

#options => Hash (readonly)

Returns

• (Hash) — additional options passed to the generator.

Back To Top

Instance Methods

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::Cli | Cuprum::Cli::Files | Cuprum::Cli::Files::Errors