ATTENTION: This package is deprecated. The Fivee wrapper for the D&D 5e SRD API is no longer actively maintained and is severely out of date. Please reconsider using Fivee for new projects, and consider replacing it with something else in existing projects that use it.

Fivee - D&D 5e API Wrapper

Fivee is a powerful typescript wrapper library for the D&D 5e SRD API

Features

• Promises - API requests are promise-based, granting lazy, asynchronous access to the API data.
• Fully Typed - Fivee provides comprehensive TypeScript interfaces for API responses.
• Data Relationships - internal references in the API data can be expanded as needed with a simple method call.

Installation

NPM

npm i fivee

Yarn

yarn add fivee

Getting Started

Import and initialise the Fivee wrapper:

const { fivee } = require('fivee')

const api = fivee()

Using an alternate instance of the 5e SRD API server:

const api = fivee({
    baseURL: 'http://localhost:3000',
})

Fetching data:

api.races.fetch('gnome')
   .then(data => {
       console.log(gnome.name, gnome.languages)
   })
   .catch(console.error)

License

This project, the Fivee API wrapper is licensed under the MIT license

D&D 5e SRD content provided by the API is licensed under the Open Game License, Version 1.0a.

The 5e SRD API is licensed under the MIT license