Interface AssertionSync<Parts, Impl, Slots>

A synchronous assertion of no specific implementation type.

interface AssertionSync<
    Parts extends AssertionParts = AssertionParts,
    Impl extends AssertionImplSync<Parts> = AssertionImplSync<Parts>,
    Slots extends AssertionSlots<Parts> = AssertionSlots<Parts>,
> {
    id: string;
    impl: Impl;
    parts: Parts;
    slots: Slots;
    execute(
        parsedValues: ParsedValues<Parts>,
        args: unknown[],
        stackStartFn: (...args: any[]) => any,
        parseResult?: ParsedResult<Parts>,
    ): void;
    parseValues<Args extends readonly unknown[]>(
        args: Args,
    ): ParsedResult<Parts>;
    toString(): string;
}

Type Parameters

Parts extends AssertionParts = AssertionParts
Impl extends AssertionImplSync<Parts> = AssertionImplSync<Parts>
Slots extends AssertionSlots<Parts> = AssertionSlots<Parts>

Hierarchy (View Summary)

Assertion<Parts, Impl, Slots>
- AssertionSync
  - AssertionFunctionSync
  - AssertionSchemaSync

Index

Methods

execute parseValues toString

Properties

id impl parts slots

Methods

execute

execute(
    parsedValues: ParsedValues<Parts>,
    args: unknown[],
    stackStartFn: (...args: any[]) => any,
    parseResult?: ParsedResult<Parts>,
): void
Execute the assertion implementation synchronously.
Parameters
- parsedValues: ParsedValues<Parts>
  Parameters for the assertion implementation
- args: unknown[]
  Raw parameters passed to expectSync()
- stackStartFn: (...args: any[]) => any
  Function to use as stack start for error reporting
- OptionalparseResult: ParsedResult<Parts>
  Optional parse result containing cached validation data
Returns void
- Defined in src/assertion/assertion-types.ts:628

parseValues

parseValues<Args extends readonly unknown[]>(args: Args): ParsedResult<Parts>
Parses raw arguments synchronously against this assertion's slots to determine if they match this assertion.
Type Parameters
- Args extends readonly unknown[]
Parameters
- args: Args
  Raw arguments provided to expectSync()
Returns ParsedResult<Parts>
Result of parsing attempt
- Defined in src/assertion/assertion-types.ts:642

toString

toString(): string
Returns the string representation of this assertion.

Returns string
Inherited from Assertion.toString
- Defined in src/assertion/assertion-types.ts:139

Properties

`Readonly`id

id: string

Unique identifier for this assertion

`Readonly`impl

impl: Impl

The implementation function or schema for this assertion.

`Readonly`parts

parts: Parts

The assertion parts used to create this assertion.

Available at runtime for introspection.

`Readonly`slots

slots: Slots

The slots derived from assertion parts for validation.