@future-widget-lab/record-set/src/libs/record-set/helpers/limit/limit.helper.ts

A dedicated data structure for in-memory record collections, offering fluent, immutable APIs for MongoDB-like querying, sorting, and transformation.

type LimitOptions<TRecord> = {
  count: number;
  records: Array<TRecord>;
};

/**
 * @description
 * Use this helper to take at most `count` records from the start of the record set.
 */
export const limit = <TRecord>(
  options: LimitOptions<TRecord>
): Array<TRecord> => {
  const { count, records } = options;

  if (count < 0) {
    return [];
  }

  if (count === 0) {
    return [];
  }

  return records.slice(0, count);
};