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

@logi.one/stormfree

v0.3.0

Published

Forever free, ultra-lightweight Rest API tester for node

Downloads

34

Readme

Storm Free

Storm Free is an ultra-lightweight (and forever free) Rest API tester for node using terminal as output.

Getting Started

Install Storm Free :

npm install --save-dev @logi.one/stormfree

Create a Javascript (or Typescript) source file with a request to your API :

import { get } from '@logi.one/stormfree'

await get('https://api.github.com/users/logione')

Run your request :

node request.mjs

Get the output in the terminal :

Request output

Examples

Make a simple GET request :

await get('https://my-api/users')

Make a request with url search parameters :

// using object
await get('https://my-api/users', { search: { active: true, name: 'john doe' }})

// using array
await get('https://my-api/users', { search: [['active', 'true'], ['name', 'john%20doe']]})

// using URLSearchParams
await get('https://my-api/users', { search: new URLSearchParams({ active: 'true', name: 'john doe' }) })

// or using string
await get('https://my-api/users', { search: 'active=true&name=john%20doe' })

// all equal the following request
await get('https://my-api/users?active=true&name=john%20doe')

POST json data :

await post('https://my-api/users', { json: { username: '[email protected]', name: 'John Doe' }})

Make a DELETE request with a bearer token :

await del('https://my-api/users/1', { token: 'my-bearer-token' })

PUT XML data :

await put('https://my-api/users/1', { 
    headers: { 'Content/type': 'application/xml' },
    body: '<active>false</active>'
})

Prevent request and status to be printed :

await get('https://my-api/users',
    { print: { request: false, status: false, headers: true, body: true } }
)

Prevent any printing :

await get('https://my-api/users', { print: false })

Integration with test runners

Storm Free integrates nicely with test runners. Test runners can be useful to select which request to run.

import { it } from 'node:test'
import assert from 'node:assert'

it.only('Get all users', async () => {
    const { ok } = await get('https://my-api/users')
    assert(ok)
})

it('Try to delete a user without authenticiation', async () => {
    const result = await del('https://my-api/users/1')
    // result is the original Response from fetch 
    assert(!result.ok)
    assert(result.status === 401)
})

If you search a rest-client that doesn't print anything, you can use @logi.one/rest-client instead