array-pager v2.0.12

Usage

//2.0.12 uses CommonJS
//2.0.11 and earlier uses ESModule
import { paginate } from "array-pager";

// Say we have a User class:
class User {
   constructor(
      public id: number,
      public name: string,
   ) {}
}

//generate an array of mock users:
const users = [
   new User(1, "John"),
   new User(2, "Jane"),
   new User(3, "Alex"),
   new User(4, "Bartholomew"),
   new User(5, "Caleb"),
   new User(6, "Dane"),
   new User(7, "Ethan"),
   new User(8, "Fred"),
   new User(9, "George"),
   new User(10, "Henry"),
   new User(11, "Ian"),
   new User(12, "Jack"),
   new User(13, "Luke"),
];

const result = paginate(users,
   {
      orderBy: {                      //may be null, applies before pagination
         field: "name",               //field to sort by, could be the id field too
         direction: "ascending",      //ascending or descending                  
      },

      current_page: 3,                //current page
      limit: 5,                       //number of items per page

      offset: -1,                     //page offset, may be negative or positive
   },                                 //it may be too large and in this case 
);                                    //it will return an empty array


console.dir(result);

// logs:
Paginated {
  count: 5,
  limit: 5,
  page: 2,
  data: [
    User { id: 8, name: 'Fred' },  
    User { id: 9, name: 'George' },
    User { id: 10, name: 'Henry' },
    User { id: 11, name: 'Ian' },  
    User { id: 12, name: 'Jack' }  
  ],
  total_pages: 3
}

const result2 = paginate(users,
   {
      orderBy: {
         field: "name",
         direction: "ascending",
      },
      current_page: 1,
      limit: 5,
      offset: 0,
   },
  
);

console.dir(result2);

//logs:
Paginated {
  count: 5,
  limit: 5,
  page: 1,
  data: [
    User { id: 3, name: 'Alex' },       
    User { id: 4, name: 'Bartholomew' },
    User { id: 5, name: 'Caleb' },      
    User { id: 6, name: 'Dane' },
    User { id: 7, name: 'Ethan' }
  ],
  total_pages: 3
}

const result3 = paginate(users,
   {
      orderBy: {
         field: "id",
         direction: "ascending",
      },
      current_page: 1,
      limit: 5,
      offset: 0,
   },
  
);

console.dir(result3);
   
//logs:
Paginated {
  count: 5,
  limit: 5,
  page: 1,
  data: [
    User { id: 1, name: 'John' },
    User { id: 2, name: 'Jane' },
    User { id: 3, name: 'Alex' },
    User { id: 4, name: 'Bartholomew' },
    User { id: 5, name: 'Caleb' }
  ],
  total_pages: 3
}

const result4 = paginate(users,
   {
      orderBy: {
         field: "id",
         direction: "descending",
      },
      current_page: 1,
      limit: 5,
      offset: 0,
   },
  
);

console.dir(result4);

//logs:
Paginated {
  count: 5,
  limit: 5,
  page: 1,
  data: [
    User { id: 13, name: 'Luke' },
    User { id: 12, name: 'Jack' },
    User { id: 11, name: 'Ian' },
    User { id: 10, name: 'Henry' },
    User { id: 9, name: 'George' }
  ],
  total_pages: 3
}