@biscuitland/api-types/README.md

## Most importantly, api-types is:

# @biscuitland/api-types

## Most importantly, api-types is:

1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API.

[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)

<img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>

## Install (for [node18](https://nodejs.org/en/download/))

```sh-session
npm install @biscuitland/api-types
yarn add @biscuitland/api-types
```

## Example

```ts
import type { DiscordUser } from '@biscuitland/api-types';
```

## Example for [Deno](https://deno.land/)

```ts
import type { DiscordUser } from "https://unpkg.com/@biscuitland/api-types@2.0.5/dist/index.d.ts";
```

We deliver this package through [unpkg](https://unpkg.com/) and it does contain constants and routes too

## Links

-   [Website](https://biscuitjs.com/)
-   [Documentation](https://docs.biscuitjs.com/)
-   [Discord](https://discord.gg/XNw2RZFzaP)
-   [core](https://www.npmjs.com/package/@biscuitland/core) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [ws](https://www.npmjs.com/package/@biscuitland/ws) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)