Add offset and limit to getUserList

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/__tests__/apis/UserApi.test.ts

@@ -20,6 +20,44 @@ test('getUserList() returns a list of users', async () => {
   expect(userList[0]).toBeInstanceOf(User);
 });
 
+test('getUserList() with limit returns a list of users', async () => {
+  nock('https://api.clerk.dev')
+    .get('/v1/users?limit=1')
+    .replyWithFile(200, __dirname + '/responses/getUserList.json', {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    });
+
+  const userList = await users.getUserList({limit: 1});
+
+  expect(userList).toBeInstanceOf(Array);
+  expect(userList.length).toEqual(1);
+
+  // const expected = new User();
+
+  // expect(userList[0]).toEqual(expected);
+
+  expect(userList[0]).toBeInstanceOf(User);
+});
+
+test('getUserList() with limit returns a list of users', async () => {
+  nock('https://api.clerk.dev')
+    .get('/v1/users?limit=1&offset=1')
+    .replyWithFile(200, __dirname + '/responses/getUserList.json', {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    });
+
+  const userList = await users.getUserList({limit: 1, offset: 1});
+
+  expect(userList).toBeInstanceOf(Array);
+  expect(userList.length).toEqual(1);
+
+  // const expected = new User();
+
+  // expect(userList[0]).toEqual(expected);
+
+  expect(userList[0]).toBeInstanceOf(User);
+});
+
 test('getUser() returns a single user', async () => {
   const expected = new User({
     id: 'user_noone',

src/apis/UserApi.ts

@@ -12,11 +12,17 @@ interface UserParams {
   privateMetadata?: object;
 }
 
+interface UserListParams {
+  limit?: number;
+  offset?: number;
+}
+
 export class UserApi extends AbstractApi {
-  public async getUserList(): Promise<Array<User>> {
+  public async getUserList(params: UserListParams = {}): Promise<Array<User>> {
     return this._restClient.makeRequest({
       method: 'get',
       path: '/users',
+      queryParams: params,
     });
   }