jroliveira/http-query-filter

View on GitHub
src/Http.Query.Filter.Client/Filters/Pagination/ILimit.cs

Summary

Maintainability
A
40 mins
Test Coverage
namespace Http.Query.Filter.Client.Filters.Pagination
{
    public interface ILimit : IFilterBase
    {
        /// <summary>
        /// A limit filter limits the number of records returned to the specified number (or less).
        /// </summary>
        /// <param name="limit">limit is the maximum number of results (records) to return.</param>
        /// <returns></returns>
        IFilterBuilder Limit(uint limit)
        {
            if (limit < 1)
            {
                limit = 1;
            }

            return this.Builder
                .AddFilter($"filter[limit]={limit}");
        }
    }
}