# devlist

> Official Dev List library for interacting with the Dev List API

Latest version **1.2.2** (published 2021-12-12) · MIT license · 0 weekly downloads

## Install

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

## 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.2.2 |
| Published | 2021-12-12 |
| First published | 2021-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | TARIQ |
| Maintainers | tariqdev |
| Keywords | devlist-api, dlist-api, devlist, dlist, developers list, developer profile, developers profile, profile, list, developer, developers |

## Links

- npm: https://www.npmjs.com/package/devlist
- Repository: https://github.com/1TGDev/devlist
- Homepage: https://docs.dlist.dev
- Issues: https://github.com/1TGDev/devlist/issues
- npm.io page: https://npm.io/package/devlist

## Dependencies (2)

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

## Recent versions

- 1.2.2 (latest) — 2021-12-12
- 1.2.1 — 2021-08-25
- 1.1.9 — 2021-08-19
- 1.1.8 — 2021-08-15
- 1.1.7 — 2021-05-01
- 1.1.6 — 2021-05-01
- 1.1.5 — 2021-05-01
- 1.1.4 — 2021-04-10
- 1.1.3 — 2021-04-10
- 1.1.2 — 2021-04-04
- 1.1.1 — 2021-03-07
- 1.1.0 — 2021-03-04
- 1.0.9 — 2021-03-04
- 1.0.8 — 2021-02-27
- 1.0.7 — 2021-02-27

## README

# Dev List

<center>
	<a href="https://nodei.co/npm/devlist/">
		<img alt="Dev List NPM Package Statistics" src="https://nodei.co/npm/devlist.png">
	</a>
</center>

* NPM package that gets information about devlist profile and other info from the Dev List API
* Useful for websites & bots where users can input any profile id/slug
* Supports the Promise-API, you will be able to use .then, .catch, etc...

Check out our documentation [Dev List](https://docs.dlist.dev).

# Installation from [NPM](https://www.npmjs.com/package/devlist)

`npm i devlist`

# Usage

[Read Documentation](https://docs.dlist.dev)

## Examples
### (Using Await)

```js
const dlist = require('devlist');
const dlist_api = new dlist.API_Controller();

async function getUserData(){
	let user = await dlist_api.profile('300530315351425024');
	console.log(user); // profile object
	let user = await dlist_api.exists('300530315351425024');
	console.log(user); // true
	let slug = await dlist_api.slug('tariq');
	console.log(slug); // 300530315351425024
	let widget = await dlist_api.widget('300530315351425024');
	console.log(widget); // widget object
}
getUserData(); // calling the function
```

### (Using .then function)

```js
const dlist = require('devlist');
const dlist_api = new dlist.API_Controller();

dlist_api.profile('300530315351425024').then(user => {
	console.log(user);
})

dlist_api.exists('300530315351425024').then(exists => {
	console.log(exists);
})

dlist_api.slug('tariq').then(slug => {
	console.log(slug);
})

dlist_api.widget('300530315351425024').then(widget => {
	console.log(widget);
})
```

### (Validation)

```js
const dlist = require('devlist');
const dlist_api = new dlist.API_Controller();

dlist_api.profile('300530315351425024').then(user => {
	if(user){
		console.log(user); // user found
	}else{
		console.log("User not found");
	}
})

dlist_api.exists('300530315351425024').then(exists => {
	if(exists){
		console.log("Profile exists");
	}else{
		console.log("Profile does not exists");
	}
})

dlist_api.slug('tariq').then(slug => {
	if(slug){
		console.log("slug is taken by: " + slug);
	}else{
		console.log("slug is available")
	}
})

dlist_api.widget('300530315351425024').then(widget => {
	if(widget){
		console.log(widget);
		// {"buffer":BUFFER,"link":"https://dlist.dev/api/profile/300530315351425024/widget.png"}
	}else{
		console.log("Profile was not found");
	}
})
```

## Contributing

© Dev List, 2021 | TARIQ (contact@itariq.dev)

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