Class: Cuprum::Cli::Files::Errors::MissingParameter

Parent Namespace

Cuprum::Cli::Files::Errors

Inherited Classes

Cuprum::Cli::Files::Errors::TemplateError > Cuprum::Error > Object

Defined In

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

Table Of Contents

• Overview
• Constants
  • TYPE
• Constructor
• Instance Attributes
  • details
  • format
  • parameter_name
  • template_name
• Instance Methods
  • initialize

Overview

Error returned when a required parameter is missing when rendering content.

Back To Top

Constants

TYPE

= 'cuprum.cli.files.errors.missing_parameter'

Short string used to identify the type of error.

Back To Top

Constructor

#initialize(parameter_name:, details: nil, format: nil, message: nil, template_name: nil) => MissingParameter

Parameters

• parameter_name (String, Symbol) — the name of the missing parameter.
• details (String) — additional information about the error.
• format (String) — the content format.
• message (String) — an optional message to display.
• template_name (String) — the name of the rendered content, if any,

Returns

• (MissingParameter) — a new instance of MissingParameter

Back To Top

Instance Attributes

#details => String (readonly)

Inherited From

Cuprum::Cli::Files::Errors::TemplateError

Returns

• (String) — additional information about the error.

#format => String (readonly)

Returns

• (String) — the content format.

#parameter_name => String, Symbol (readonly)

Returns

• (String, Symbol) — the name of the missing parameter.

#template_name => String (readonly)

Inherited From

Cuprum::Cli::Files::Errors::TemplateError

Returns

• (String) — the name of the rendered content, if any,

Back To Top

Instance Methods

Back To Top

---

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