Method snap

ark/attest/assert/chainableAssertions.ts:122–175

()

	}

	get snap(): snapProperty<unknown, AssertionKind> {
		// Use variadic args to distinguish undefined being passed explicitly from no args
		const inline = (...args: unknown[]) => {
			const snapName = this.ctx.lastSnapName ?? "snap"
			const expectedSerialized = snapshot(args[0])
			if (!args.length || this.ctx.cfg.updateSnapshots) {
				const position = caller()
				if (this.ctx.cfg.failOnMissingSnapshots) {
					throw new MissingSnapshotError(
						`.${snapName}() at ${positionToString(position)} must be populated.`
					)
				}
				if (this.snapRequiresUpdate(expectedSerialized)) {
					const snapshotArgs: SnapshotArgs = {
						position,
						serializedValue: this.serializedActual,
						snapFunctionName: snapName
					}
					queueSnapshotUpdate(snapshotArgs)
				}
			} else {
				// compare as strings, but if match fails, compare again as objects
				// to give a clearer error message. This avoid problems with objects
				// like subtypes of array that do not pass node's deep equality test
				// but serialize to the same value.
				if (printable(args[0]) !== printable(this.unversionedActual))
					assertEquals(expectedSerialized, this.serializedActual, this.ctx)
			}
			return this
		}
		const toFile = (id: string, opts?: ExternalSnapshotOptions) => {
			const expectedSnapshot = getSnapshotByName(
				this.ctx.position.file,
				id,
				opts?.path
			)
			if (!expectedSnapshot || this.ctx.cfg.updateSnapshots) {
				if (this.snapRequiresUpdate(expectedSnapshot)) {
					updateExternalSnapshot({
						serializedValue: this.serializedActual,
						position: caller(),
						name: id,
						customPath: opts?.path
					})
				}
			} else assertEquals(expectedSnapshot, this.serializedActual, this.ctx)

			return this
		}
		return Object.assign(inline, {
			toFile,
			unwrap: this.unwrap.bind(this)
		})
	}

	private immediateOrChained() {
		const immediateAssertion = (...args: [expected: unknown]) => {