# idgames

> This is a nodejs wrapper around the idgames API documented at https://www.doomworld.com/idgames/api/

Latest version **1.0.2** (published 2024-04-26) · MIT license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2024-04-26 |
| First published | 2024-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Anthony W. Weed |
| Maintainers | noot |
| Keywords | doom, idgames, doomworld, api |

## Links

- npm: https://www.npmjs.com/package/idgames
- Repository: https://github.com/devnoot/idgames
- Issues: https://github.com/devnoot/idgames/issues
- npm.io page: https://npm.io/package/idgames

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.2.4

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2024-04-26

## README

# idgames

This is a wrapper around the idgames archive public API documented at https://www.doomworld.com/idgames/api/

## Quick Start

```bash
npm install idgames
```

```typescript
import { ping, dbPing, about, get, getParentDir, getDirs, getContents, latestVotes, latestFiles, search } from 'idgames'

;(async () => {
    const ping = await ping()

    const dbping = await dbPing()

    const about = await about()

    const get = await get({ id: '15156' })

    const getparentdir = await getParentDir({ id: '666' })

    const getdirs = await getDirs({ name: 'zvox' })

    const getfiles = await getFiles({ id: '10666' })

    const getcontents = await getContents({ id: '666' })

    const latestvotes = await latestVotes({ limit: 25 })

    const latestfiles = await latestFiles({ limit: 10 })

    const search = await search({ query: 'UDM2' })
})()
```

## Usage

### Methods

Each function in this package will return a promise resolving in the requested data. The following functions are available.

-   ping
-   dbPing
-   about
-   get
-   getParentDir
-   getDirs
-   getContents
-   latestVotes
-   latestFiles
-   search

## Contributions

Please issue a pull request

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