Class MutationContext<T>

The mutation context that will be provided to the security function.

Type Parameters

T = any

Index

Accessors

Methods

affectedPaths affectsPath getMutationType

Properties

beforeAndAfterDocs mutation serverTimeStamp

Accessors

after

get after(): undefined | T
Returns the state of the document after the mutation was applied.

Returns undefined | T

before

get before(): undefined | T
Returns the state of the document before the mutation was applied.

Returns undefined | T

Methods

affectedPaths

affectedPaths(startingRoot?: string | Paths<T>): Paths<T>[]
Find all affected paths starting from a root path.
Parameters
- startingRoot: string | Paths<T> = ''
Returns Paths<T>[]
Example
```
doc before - { a: { b: 1, c: 2 }, d: 3 }
doc after - { a: { b: 1, c: 3 }, d: 4 }
doc.affectedPaths('a') // ['a.c']
```

affectsPath

affectsPath(path: Paths<T>): boolean
Returns true if the mutation affects the provided path.
Parameters
- path: Paths<T>
Returns boolean

getMutationType

getMutationType(): "delete" | "insert" | "update"
Returns the type of the mutation (insert, update, or delete).

Returns "delete" | "insert" | "update"

Properties

`Readonly`beforeAndAfterDocs

beforeAndAfterDocs: BeforeAndAfterDocs<T>

`Readonly`mutation

mutation: Mutation<T>

`Readonly`serverTimeStamp

serverTimeStamp: Date