Class Firestorm

constructor

• new Firestorm(name?: string): Firestorm

  Create an instance of Firestorm.

  It doesn't instantly connect. You have to make a call to connect for that

  Parameters

  • Optionalname: string

    Name of the instance

  Returns Firestorm

Readonlyname

firebaseApp

• get firebaseApp(): FirebaseApp | null

  The underlying firebase app

  Returns FirebaseApp | null

firebaseAuth

• get firebaseAuth(): Auth

  The instance of auth

  Returns Auth

firebaseStorage

• get firebaseStorage(): FirebaseStorage

  The instance of storage

  Returns FirebaseStorage

firestore

• get firestore(): Firestore

  The instance of firestorm

  Returns Firestore

isConnected

• get isConnected(): boolean

  True if this instance if connected to a firestore

  Returns boolean

options

• get options(): FirebaseOptions | null

  Gets the (read-only) options of this firestorm instance.

  Returns FirebaseOptions | null

storage

• get storage(): FirestormStorage

  Gets a storage repository

  Returns FirestormStorage

connect

• connect(options?: FirebaseOptions): void

  Connect to the DB.

  If an app with the same name already exists, it will use that. Otherwise it will create a new instance using the options.

  Parameters

  • Optionaloptions: FirebaseOptions

    Options to create the app

  Returns void

  Throws

  if no previous app of the same name and no options provided

getCrudRepository

• getCrudRepository<T extends IFirestormModel>(
      type: Type<T>,
      path?: PathLike,
  ): CollectionCrudRepository<T>

  Gets the basic CRUD repository for a model

  Type Parameters

  • T extends IFirestormModel

    Type of the model

  Parameters

  • type: Type<T>

    Type of the model

  • Optionalpath: PathLike

    The path to the collection to get the repository on

  Returns CollectionCrudRepository<T>

getRepositoryFromFunction

• getRepositoryFromFunction<R extends Repository<T>, T extends IFirestormModel>(
      generator: RepositoryInstantiator<R, T>,
      type: Type<T>,
      path?: PathLike,
  ): R

  Creates a repository using a generator function

  Type Parameters

  • R extends Repository<T>

    Type of the repository

  • T extends IFirestormModel

    Type of the model

  Parameters

  • generator: RepositoryInstantiator<R, T>

    Generator function of the repository

  • type: Type<T>

    Type of the model

  • Optionalpath: PathLike

    The path to the collection to get the repository on

  Returns R

getSingleDocumentCrudRepository

• getSingleDocumentCrudRepository<T extends IFirestormModel>(
      type: Type<T>,
      documentId: string,
      path?: PathLike,
  ): DocumentCrudRepository<T>

  Gets the mono document CRUD repository for a model

  Type Parameters

  • T extends IFirestormModel

  Parameters

  • type: Type<T>

    Type of the document model

  • documentId: string

    Id of the document

  • Optionalpath: PathLike

    The path to the collection to get the repository on

  Returns DocumentCrudRepository<T>

useEmulator

• useEmulator(options?: EmulatorConnectionOptions): void

  Call this after connecting to use the emulator instead of the database.

  Parameters

  • Optionaloptions: EmulatorConnectionOptions

    Connection options. Defaults to DEFAULT_EMULATOR_OPTIONS

  Returns void