# ascer

> Easily access the randomuser.me API

Latest version **1.0.1** (published 2021-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install ascer
pnpm add ascer
yarn add ascer
bun add ascer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-03-29 |
| First published | 2021-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Hodd |
| Maintainers | hodd1444 |
| Keywords | random, generation |

## Links

- npm: https://www.npmjs.com/package/ascer
- Repository: https://github.com/Hodd1444/ascer
- Homepage: https://github.com/Hodd1444/ascer#readme
- Issues: https://github.com/Hodd1444/ascer/issues
- npm.io page: https://npm.io/package/ascer

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Recent versions

- 1.0.1 (latest) — 2021-03-29
- 1.0.0 — 2021-03-29

## README

# What is ascer?

Ascer is a npm module to easily access the https://randomuser.me API and help you make your code less cluttery (but tbh it is infact not very useful)

# Installation

`npm install ascer`

# Example

```js
const {getRandomUser} = require('ascer');

( async () => {

    // Gets a random user and displays their first and last name
    const user = await getRandomUser();
    console.log(user.name.first + ' ' + user.name.last)

    // Gets a random male user and displays their first and last name
    // Gender options are 'male' and 'female'
    const maleUser = await getRandomUser({gender: 'male'});
    console.log(maleUser.name.first + ' ' + maleUser.name.last)

})();
```

### Options

`gender`: _'male' | 'female'_


This is a very useless module I only created for myself but feel free to use it if you need!

---
_Source: https://npm.io/package/ascer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._