Class Mutators

Hierarchy

Mutators

Index

Constructors

Properties

DefaultCollectionKeyValueMutator

Methods

SimulatedUserMutator SpecificKeyFieldKVMutator

Constructors

constructor

new Mutators(): Mutators
Returns Mutators

Properties

`Static` DefaultCollectionKeyValueMutator

DefaultCollectionKeyValueMutator: CollectionMutator<QuerySnapshot<DocumentData>> = ...

The DefaultCollectionKeyValueMutator field is a default key-value mutator.

Methods

`Static` SimulatedUserMutator

SimulatedUserMutator(keyLocator?: ((data: IUserData) => string)): CollectionMutator<DMap<string, IUserData>>
Parameters
- keyLocator: ((data: IUserData) => string) = ...
  - - (data: IUserData): string
    - Parameters
      
      data: IUserData
      
      Returns string
Returns CollectionMutator<DMap<string, IUserData>>
- Defined in builtin/data/Mutators.ts:31

`Static` SpecificKeyFieldKVMutator

SpecificKeyFieldKVMutator(keyLocator?: ((doc: DocumentSnapshot<DocumentData>) => string)): CollectionMutator<QuerySnapshot<DocumentData>>
The SpecificKeyFieldKVMutator() method produce CollectionMutator that mutates collection array to the key-value object.

Returns
CollectionMutator
Parameters
- keyLocator: ((doc: DocumentSnapshot<DocumentData>) => string) = ...
  
  Key locator function finds the value that will be object key.
  - - (doc: DocumentSnapshot<DocumentData>): string
    - Parameters
      
      doc: DocumentSnapshot<DocumentData>
      
      Returns string
Returns CollectionMutator<QuerySnapshot<DocumentData>>
- Defined in builtin/data/Mutators.ts:19

Generated using TypeDoc