BUPKIS
    Preparing search index...

    Module bupkis

    Main entry point for the Bupkis assertion library.

    This module exports all public APIs including the main expect function, asynchronous expectAsync function, assertion creation utilities, type guards, schema definitions, utility functions, and error types.

    import { expect, expectAsync, z, createAssertion } from 'bupkis';
    

    Zod v4 is exported as z if you aren't already using a Standard Schema V1-compatible validation library.

    Core API

    createAssertion
    createAsyncAssertion
    expect
    expectAsync
    fail
    use
    Expect
    ExpectAsync
    ExpectIt
    ExpectItAsync
    FailFn
    AssertionError
    Bupkis
    CreateAssertionFn
    CreateAsyncAssertionFn
    UseFn

    Assertion Creation

    AssertionFailure

    Error Options

    AssertionErrorOptions
    AssertionImplementationErrorOptions
    InvalidMetadataErrorOptions
    InvalidSchemaErrorOptions
    UnknownAssertionErrorOptions

    Errors

    AssertionError
    AssertionImplementationError
    BupkisError
    FailAssertionError
    InvalidMetadataError
    InvalidObjectSchemaError
    SatisfactionError
    UnexpectedAsyncError
    UnknownAssertionError

    Interfaces

    StandardSchemaV1

    Internal Assertion Interfaces

    AssertionStandardSchemaAsync
    AssertionStandardSchemaSync

    Namespaces

    assertions
    StandardSchemaV1
    types

    References

    schema → schema

    Type Aliases

    FailAssertionErrorOptions

    Utility Types

    Keypath