@furystack/rest/src/endpoint-models/get-collection-endpoint.ts

Generic REST package

import type { FindOptions } from '@furystack/core'

/**
 * Response Model for GetCollection
 */
export type GetCollectionResult<T> = {
  /**
   * The Total count of entities
   */
  count: number
  /**
   * List of the selected entities
   */
  entries: T[]
}

/**
 * Rest endpoint model for getting / querying collections
 */
export type GetCollectionEndpoint<T> = {
  query: { findOptions?: FindOptions<T, Array<keyof T>> }
  result: GetCollectionResult<T>
}