users-interview-api
TypeScript icon, indicating that this package has built-in type declarations

0.0.6 • Public • Published

Fake users API for interviews

NPM

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

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<User, 'id' | 'last_modified_timestamp'>) => Promise<User>;

Some usage examples:

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));

Readme

Keywords

none

Package Sidebar

Install

npm i users-interview-api

Weekly Downloads

3

Version

0.0.6

License

ISC

Unpacked Size

22.1 kB

Total Files

9

Last publish

Collaborators

  • vvscode