Contents

# typed: strict
# frozen_string_literal: true

module LunchMoney
  # This class is used to represent errors returned directly from the LunchMoney API. This class has been set up to act
  # like an array, delegating a lot of common array getter methods directly to messages for you.
  # @example
  #   api = LunchMoney::Api.new
  #   response = api.categories
  #
  #   response.class
  #   => LunchMoney::Errors
  #
  #   response.first
  #   => "Some error returned by the API"
  #
  #   response.empty?
  #   => false
  #
  #   response[0]
  #   => "Some error returned by the API"
  class Errors
    sig { returns(T::Array[String]) }
    attr_accessor :messages

    sig { params(message: T.nilable(String)).void }
    def initialize(message: nil)
      @messages = T.let([], T::Array[String])

      @messages << message unless message.nil?
    end

    delegate :[], :<<, :each, :to_a, :first, :last, :empty?, :present?, to: :@messages
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
lunchmoney-1.4.0	lib/lunchmoney/errors.rb
lunchmoney-1.2.0	lib/lunchmoney/errors.rb
lunchmoney-1.1.2	lib/lunchmoney/errors.rb
lunchmoney-1.1.1	lib/lunchmoney/errors.rb