Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nate-wilkins/schema-lanyard-discord-presence

Schema to type and validate Lanyard discord presence data.
https://github.com/nate-wilkins/schema-lanyard-discord-presence

Last synced: 6 days ago
JSON representation

Schema to type and validate Lanyard discord presence data.

Host: GitHub
URL: https://github.com/nate-wilkins/schema-lanyard-discord-presence
Owner: Nate-Wilkins
License: apache-2.0
Created: 2023-02-04T23:07:13.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-01-30T14:19:45.000Z (12 months ago)
Last Synced: 2024-12-12T14:21:29.939Z (about 1 month ago)
Language: TypeScript
Size: 429 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # schema-lanyard-discord-presence

[![Version](http://img.shields.io/npm/v/schema-lanyard-discord-presence.svg?style=flat-square)](https://www.npmjs.org/package/schema-lanyard-discord-presence)

[![Build](https://img.shields.io/travis/Nate-Wilkins/schema-lanyard-discord-presence/main?style=flat-square)](https://app.travis-ci.com/github/Nate-Wilkins/schema-lanyard-discord-presence)

[![Open Issues](https://img.shields.io/github/issues-raw/Nate-Wilkins/schema-lanyard-discord-presence?style=flat-square)](https://github.com/Nate-Wilkins/schema-lanyard-discord-presence/issues)

[![License](https://img.shields.io/github/license/Nate-Wilkins/schema-lanyard-discord-presence?color=%2308F&style=flat-square)](https://github.com/Nate-Wilkins/schema-lanyard-discord-presence/blob/main/LICENSE)

> Schema to type and validate Lanyard discord presence data.

```

yarn add schema-lanyard-discord-presence

```

## Usage

```typescript

import { SchemaDiscordPresence, DiscordPresence } from 'schema-lanyard-discord-presence';

const discordPresence: DiscordPresence = await SchemaDiscordPresence.validate(data);

```

## External Resources

- [Lanyard API](https://github.com/Phineas/lanyard)

- [Discord API Public Flags](https://discord.com/developers/docs/resources/user#user-object-user-flags)

- [React Discord Presence](https://github.com/Nate-Wilkins/react-discord-presence)

## Roadmap

- Add more data properties from the Lanyard API.

- Update yup to support nullable and default behaviors.