Function validate

  • validate<T>(results: T[]): NonEmptyArray<T>

    Ensures an array contains at least one element

    Type Parameters

    • T

    Parameters

    • results: T[]

      The array to validate

    Returns NonEmptyArray<T>

    The original array, typed as NonEmptyArray

    Throws

    When the array is empty or not an array

    Example

    // Successful validation
    const items = validate([1, 2, 3]);
    // items is now typed as NonEmptyArray<number>

    // Throws NonEmptyArrayError
    try {
      const empty = validate([]);
    } catch (error) {
      if (error instanceof NonEmptyArrayError) {
        // Handle empty array error
      }
    }

    Remarks

    • Throws a specific NonEmptyArrayError for better error handling
    • Returns the original array with a more specific type
    • Useful when you need to ensure an array has elements before processing
    • Can be used as a runtime type assertion

Settings

Member Visibility