Interface CreateAssertionFn

The main factory function for creating synchronous assertions.

CreateAssertionFn<
    const Parts extends AssertionParts,
    Impl extends RawAssertionImplSchemaSync<Parts>,
    Slots extends

            | readonly [
                | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
                | PhraseLiteralSlot<string>
                | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
            ]
            | readonly [
                z.ZodUnknown,
                | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
                | PhraseLiteralSlot<string>
                | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
            ],
>(
    parts: Parts,
    impl: Impl,
): AssertionSchemaSync<Parts, AssertionImplSchemaSync<Parts>, Slots>
Create a synchronous Assertion from parts and a Zod schema.
Type Parameters
- const Parts extends AssertionParts
  Parts defining the shape of the assertion, including Phrases and Zod schemas
- Impl extends RawAssertionImplSchemaSync<Parts>
  Assertion implementation as a Zod schema
- Slots extends
      | readonly [
          | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | PhraseLiteralSlot<string>
          | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
      ]
      | readonly [
          z.ZodUnknown,
          | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | PhraseLiteralSlot<string>
          | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
      ]
  Inferred slots based on the provided Parts
Parameters
- parts: Parts
- impl: Impl
Returns AssertionSchemaSync<Parts, AssertionImplSchemaSync<Parts>, Slots>
New AssertionSchemaSync object
- Defined in src/types.ts:200
CreateAssertionFn<
    const Parts extends AssertionParts,
    Impl extends AssertionImplFnSync<Parts>,
    Slots extends

            | readonly [
                | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
                | PhraseLiteralSlot<string>
                | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
            ]
            | readonly [
                z.ZodUnknown,
                | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
                | PhraseLiteralSlot<string>
                | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
            ],
>(
    parts: Parts,
    impl: Impl,
): AssertionFunctionSync<Parts, Impl, Slots>
Create a synchronous Assertion from parts and an implementation function.
Type Parameters
- const Parts extends AssertionParts
  Parts defining the shape of the assertion, including Phrases and Zod schemas
- Impl extends AssertionImplFnSync<Parts>
  Assertion implementation as a function
- Slots extends
      | readonly [
          | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | PhraseLiteralSlot<string>
          | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
      ]
      | readonly [
          z.ZodUnknown,
          | z.ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
          | PhraseLiteralSlot<string>
          | PhraseLiteralChoiceSlot<PhraseLiteralChoice>,
      ]
  Inferred slots based on the provided Parts
Parameters
- parts: Parts
- impl: Impl
Returns AssertionFunctionSync<Parts, Impl, Slots>
New AssertionFunctionSync object
- Defined in src/types.ts:219

Interface CreateAssertionFn

Type Parameters

Parameters

Returns AssertionSchemaSync<Parts, AssertionImplSchemaSync<Parts>, Slots>

Type Parameters

Parameters

Returns AssertionFunctionSync<Parts, Impl, Slots>

Settings