deno_snapshots.deno.txt

                  
   DENO_SNAPSHOTS  
                  



ALTERNATIVES ==>                  #See Jest snapshots

VERSION ==>                       #Part of Deno test (see its doc)

std/testing/snapshot.ts           #Entrypoint (std library)


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:          ASSERTIONS           :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


createAssertSnapshot
 (OPTS, assertSnapshot)
 ->assertSnapshot                 #Binds OPTS

assertSnapshot(T, VAL[, OPTS])->> #Either assert|update snapshot

OPTS.mode                         #One of:
                                 R#  - 'assert' (def): throw on difference or missing snapshot file
                                WR#  - 'update':
                                  #     - ignore difference or missing snapshot file
                                  #     - update snapshot file
deno test ... -- --update|-u      #Sets OPTS.mode default to 'update'

OPTS.msg                          #Error 'MESSAGE'


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:             FILES             :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


OPTS.path                         #'PATH' of the snapshot file.
                                  #Def: '{OPTS.dir}/TEST_FILENAME.snap'
OPTS.dir                          #'DIR'. Relative to test file.
                                  #Def: '__snapshots__'

OPTS.name                         #STR. Snapshot name. Def: '[... PARENT_TEST_TITLE >] TEST_TITLE'
                                  #Always appends a NUM incremented at each assertSnapshot() inside test


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:          SERIALIZER           :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


SNAPSHOT FILE ==>                 #Export a snapshot OBJ where key is OPTS.name and value is serialized snapshot

OPTS.serialize                    #FUNC(VAL)->STR to serialize snapshots. Def: serialize()
serialize(VAL)->STR               #Deno.inspect() with OPTS:
                                  #  - depth|iterableLimit|strAbbreviateSize Infinity: full OBJ
                                  #  - sorted true: stable output
                                  #  - compact false
                                  #  - trailingComma true
                                  #And \\n -> \n