Module: Kagaribi

Defined in:
sig/kagaribi/collection.rbs,
lib/kagaribi.rb,
lib/kagaribi/version.rb,
lib/kagaribi/collection.rb,
sig/kagaribi.rbs

Overview

Classes

Defined Under Namespace

Classes: Collection, Error

Constant Summary collapse

VERSION =

Returns:

  • (String) 
"0.2.2"

Class Method Summary collapse

Class Method Details

.collection(collection_name, database_id: nil, logger: nil) ⇒ Kagaribi::Collection

Parameters:

  • collection_name (String)
  • database_id (String, nil) (defaults to: nil) —

    Identifier for a Firestore database. If not present, the default database of the project is used.

  • logger (Logger) (defaults to: nil) —

    default is STDOUT Logger

  • database_id: (string, nil) (defaults to: nil)
  • logger: (Logger, nil) (defaults to: nil)

Returns:



17
18
19
 
# File 'lib/kagaribi.rb', line 17

def self.collection(collection_name, database_id: nil, logger: nil)
  Collection.new(collection_name, database_id: database_id, logger: logger)
end