Git Product home page Git Product logo

open5e-ts's Introduction

Makes working with Open5e data in Typescript a breeze. All data is validated using Zod schemas, which gives high quality autocomplete your editor and full runtime safety. Usable on client and server.

Supports the following API endpoints:

  • Monsters
  • Spells
  • Classes
  • Magic Items
  • Races

Install

npm install @sturlen/open5e-ts
pnpm install @sturlen/open5e-ts

Usage

import { Open5e } from "@sturlen/open5e-ts"

const api = new Open5e()

// Query up to 50 dragons from the Tome of Beasts books.
const dragons = await api.monsters.findMany({
    limit: 50,
    document__slug: ["tob", "tob2", "tob3"],
    search: "dragon",
})

// Use the result as you see fit
dragons.forEach((monster) => console.log("Challenge: " + monster.challenge_rating))


// Get a specific item by it's id/slug
const spell = await api.spells.get("cure-wounds")

console.log(spell.range) // Touch

// You can access the Zod schemas and use them separately
api.monsters.schema.parse(YourObject)

References

Open5e Site Open5e API

open5e-ts's People

Contributors

sturlen avatar

Stargazers

Aaron Staes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.