Class ArkErrors

ark/schema/shared/errors.ts:162–342

 * ArkError intersection.
 */
export class ArkErrors
	extends ReadonlyArray<ArkError>
	implements StandardSchemaV1.FailureResult
{
	readonly [arkKind] = "errors"

	/**
	 * Inherited array methods (`map`, `filter`, `slice`, …) return a plain
	 * `Array`, not another `ArkErrors`, so callbacks that return primitives
	 * (e.g. `issues.map(i => i.message)`) cannot populate a new `ArkErrors` instance.
	 */
	static get [Symbol.species](): ArrayConstructor {
		return Array
	}

	protected ctx: Traversal

	constructor(ctx: Traversal) {
		super()
		this.ctx = ctx
	}

	/**
	 * Errors by a pathString representing their location.
	 */
	byPath: Record<string, ArkError> = Object.create(null)

	/**
	 * {@link byPath} flattened so that each value is an array of ArkError instances at that path.
	 *
	 * ✅ Since "intersection" errors will be flattened to their constituent `.errors`,
	 * they will never be directly present in this representation.
	 */
	get flatByPath(): Record<string, ArkError[]> {
		return flatMorph(this.byPath, (k, v) => [k, v.flat])
	}

	/**
	 * {@link byPath} flattened so that each value is an array of problem strings at that path.
	 */
	get flatProblemsByPath(): Record<string, string[]> {
		return flatMorph(this.byPath, (k, v) => [k, v.flat.map(e => e.problem)])
	}

	/**
	 * All pathStrings at which errors are present mapped to the errors occuring
	 * at that path or any nested path within it.
	 */
	byAncestorPath: Record<string, ArkError[]> = Object.create(null)

	count = 0
	private mutable: ArkError[] = this as never

	/**
	 * Throw a TraversalError based on these errors.
	 */
	throw(): never {
		throw this.toTraversalError()