Git Product home page Git Product logo

ts-fivee's Introduction

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

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.