@magitools/forem-wrapper
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

@magitools/forem-wrapper

A Forem API(v1) wrapper.

Current Features:

  • articles (see list of endpoint here)

Usage

To use this package, simply install it in your project by using npm, yarn or pnpm

npm install @magitools/forem-wrapper

You can then instatiate it like so:

import ForemClient from "@magitools/forem-wrapper";

const client = new ForemClient();

you can specify a different forem instance in the constructor if you don't want to send requests to dev.to

const client = new ForemClient("https://your-forem.com/api");

if you need to use endpoints requiring an api-key, you can add one like so:

const client = new ForemClient().setApiKey("your_api_key");

you can view a usage example in the example folder (also accessible as a demo here)

Readme

Keywords

none

Package Sidebar

Install

npm i @magitools/forem-wrapper

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

17.8 kB

Total Files

5

Last publish

Collaborators

  • matfire