Method: FService::Base#failure

Defined in:

lib/f_service/base.rb

#failure(data = nil) ⇒ Result::Failure

Deprecated.

Use #Failure instead.

Returns a failed operation. You’ll probably want to return this inside #run.

Examples:

class User::ValidateAge < FService::Base
  def initialize(age:)
    @age = age
  end

  def run
    return failure(status: 'No age given!', data: @age) if age.blank?
    return failure(status: 'Too young!', data: @age) if age < 18

    success(status: 'Valid age.', data: @age)
  end
end

Returns:

• (Result::Failure) —

  a failed operation

# File 'lib/f_service/base.rb', line 251

def failure(data = nil)
  FService.deprecate!(
    name: "#{self.class}##{__method__}",
    alternative: '#Failure',
    from: caller[0]
  )

  Result::Failure.new(data)
end