https://github.com/Dinographic/GuildedAPI-Types
Up to date Guilded API Typings.
https://github.com/Dinographic/GuildedAPI-Types
api guilded guilded-api node typescript
Last synced: 4 months ago
JSON representation
Up to date Guilded API Typings.
- Host: GitHub
- URL: https://github.com/Dinographic/GuildedAPI-Types
- Owner: DinographicPixels
- License: apache-2.0
- Created: 2022-10-23T19:53:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T10:31:21.000Z (over 1 year ago)
- Last Synced: 2025-01-29T11:05:53.483Z (about 1 year ago)
- Topics: api, guilded, guilded-api, node, typescript
- Language: TypeScript
- Homepage:
- Size: 140 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Guilded API Types
## Every type definitions for the [Guilded API](https://www.guilded.gg/docs/api/).
# Installation
```bash
npm install guildedapi-types.ts
```
# Get started
To import the API Types, you need to choose the API version. E.g: `guildedapi-types.ts/v1`
You can import every types or some, E.g:
```typescript
import * as APITypes from 'guildedapi-types.ts/v1'
```
```typescript
import { APIGuild } from 'guildedapi-types.ts/v1'
```
To use most of types, you'll need Typescript.
Here's an example:
```typescript
const GuildCategory: APIGuildCategories = 'community';
```
# Who's using those types?
- TouchGuild (Guilded Library)
### When modifications are needed, feel free to make PRs.
# Links
- [GitHub](https://github.com/DinographicPixels/GuildedAPI-Types)
- [NPM](https://www.npmjs.com/package/guildedapi-types.ts)
- [Guilded API Documentation](https://www.guilded.gg/docs/api/)