tiramisu/seyfert
5
0
Fork 0
mirror of https://github.com/tiramisulabs/seyfert.git synced 2025-07-01 20:46:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: api-types readme

Browse Source
This commit is contained in:
Yuzu 2022-08-01 20:13:45 -05:00
parent bd7b8bca52
commit dc6dd6c08b
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
packages/api-types/README.md Normal file
View File

@ -0,0 +1,29 @@
# biscuit
## A brand new bleeding edge non bloated Discord library
<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
```
for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
## Most importantly, api-types is:
1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API
## Example
```ts
import type { DiscordUser } from '@biscuitland/api-types';
```
## Example for [Deno](https://deno.land/)
```
import type { DiscordUser } from "https://unpkg.com/@biscuitland/api-types@1.1.0/dist/index.d.ts";
```
We deliver this package through [unpkg](https://unpkg.com/) and it does contain constants and routes too