npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@enspirit/magicrest

v0.1.0

Published

Super easy, magical and universal REST api client on top of axios

Downloads

4

Readme

magicrest

The goal of this library is to make rest api clients easy and generic.

Usage example


import { createClient } from '@enspirit/magicrest';

const client = createClient('http://localhost');

// GET http://localhost/
await client.get();

// GET http://localhost/people
await client.people.get();

// GET http://localhost/people?filter=value
await client.people.get({ filter: 'value' });

// GET http://localhost/people/12
await client.people(12).get();

// GET http://localhost/people/12/hobbies
await client.people(12).hobbies.get();

// DELETE http://localhost/people/12/hobbies/24
await client.people(12).hobbies(24).delete();

// POST http://localhost/people/12/hobbies
// with body: { name: 'Bass playing' }
await client.people(12).hobbies.post({ name: 'Bass playing' });

// You can create clients with defaults
const authdApi = client.withDefaults({ headers: { Authorization: 'Bearer some-token' }});
await authdApi.my.profile.get();

// Subclients deep merge their settings
const authdApiWithMoreHeaders = authdApi.withDefaults({
  headers: {
    Accept: 'application/xml'
  }
});
await authdApiWithMoreHeaders.finance.reports.year(2022).get();

Close relationship with Promises

It is important to know that magicrest only triggers HTTP request when the Promise API is being used.

This means that http request will only be triggered when one of the following method is being called on magicrest's returned objects:

  • then()
  • catch()
  • finally()