Skip to content

Snapshot

[<Interface>]
type Snapshot =
    static member Create (setDefaultSnapshotSerializers: (obj -> obj) array -> unit, setResolveSnapshotPath: (string option -> string) -> unit) : Snapshot
    abstract member setDefaultSnapshotSerializers (serializers: (obj -> obj) array) : unit
    abstract member setResolveSnapshotPath (fn: string option -> string) : unit
AssemblyXantham.Fable.Node
Attributes[<Interface>]

Methods

static member Create (setDefaultSnapshotSerializers: (obj -> obj) array -> unit, setResolveSnapshotPath: (string option -> string) -> unit) : Snapshot
abstract member setDefaultSnapshotSerializers (serializers: (obj -> obj) array) : unit

This function is used to customize the default serialization mechanism used by the test runner.

By default, the test runner performs serialization by calling JSON.stringify(value, null, 2) on the provided value. JSON.stringify() does have limitations regarding circular structures and supported data types. If a more robust serialization mechanism is required, this function should be used to specify a list of custom serializers.

Serializers are called in order, with the output of the previous serializer passed as input to the next. The final result must be a string value.

@since v22.3.0

Parameter
serializersAn array of synchronous functions used as the default serializers for snapshot tests.
abstract member setResolveSnapshotPath (fn: string option -> string) : unit

This function is used to set a custom resolver for the location of the snapshot file used for snapshot testing. By default, the snapshot filename is the same as the entry point filename with .snapshot appended.

@since v22.3.0

Parameter
fnA function used to compute the location of the snapshot file. The function receives the path of the test file as its only argument. If the test is not associated with a file (for example in the REPL), the input is undefined. fn() must return a string specifying the location of the snapshot file.