https://github.com/vvscode/users-interview-api

Api stub for interviews
https://github.com/vvscode/users-interview-api

hacktoberfest

Last synced: about 1 year ago
JSON representation

Api stub for interviews

• Host: GitHub
• URL: https://github.com/vvscode/users-interview-api
• Owner: vvscode
• Created: 2021-10-21T11:19:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-16T15:56:02.000Z (over 3 years ago)
• Last Synced: 2024-10-29T18:28:15.069Z (over 1 year ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Fake users API for interviews

[![NPM](https://nodei.co/npm/users-interview-api.png)](https://npmjs.org/package/users-interview-api)

The package provides next api, which can be used during the interview:

```ts

declare type User = {

    name: string;

    email: string;

    login: string;

    id: number;

    last_modified_timestamp: number;

};

export declare const getUsers: ({ page, limit }: {

    page?: number | undefined;

    limit?: number | undefined;

}) => Promise<{

  data:User[],

  total: number,

  page: number,

  pageSize: number

}>;

export declare const createUser: (userData: Omit) => Promise;

```

---

Some usage examples:

```ts

import { getUsers, createUser } from 'users-interview-api';

// get list of users (default page)

getUsers().then((usersList) => console.log('users:', usersList));

// specific page

getUsers({ page: 2, limit: 3 }).then((usersList) => console.log('users:', usersList.data));

// create new user

createUser({

    name: 'Bob',

    email: 'b0b@mail.cool',

    login: 'dud3',

}).then((user) => console.log('New user created:', user));

```