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

@knovator/api

v1.0.4

Published

Simple API Wrapper for axios to achieve productive api calls

Downloads

48

Readme

@knovator/api

npm npm npm bundle size

@knovator/api provides simple wrapper for api calls and makes it much easier to mange your api calls. It provides two methods fetchUrl and setAPIConfig.

setAPIConfig

You need to set wrapper's config one time before calling api. You can find docs for it.

| config | type | use | | ------------- | ---------------------- | ------------------------------------------------------------ | | getToken | function or string | for private APIs getToken method to get an updated token from localStorage or state or it's up to you and you also pass a string to it | | baseUrl | string | API endpoint url (Note:do not pass '/' at the end of url) | | prefix | function or string | You can use a common prefix between API Endpoint and the URL of API. a prefix is an optional parameter. A prefix can be the function as well as string type. If you are using prefix as a function then you will get your passed config in arguments. | | onError | function | It is optional but if you pass function then it will be called on any error in API | | handleCache | boolean | To enable API cancellation set it true. When enabled, If the last API URL and the current API URL are the same then the last API will get canceled to prevent unnecessary API calls. | | tokenPrefix | false or string | by default it will use Bearer for prefix, to not pass any prefix with authorization pass false |

import { setAPIConfig } from "@knovator/api"

const getToken = () => {
    // do something and return token for authorization
    return token
}

setAPIConfig({
    getToken: getToken(),
    prefix: 'admin',
    baseUrl: `${process.env.FETCH_URL}`,
})
...

fetchUrl

fetchUrl takes single parameter under that

| Param | Use | Default Value | | :----: | :----------------------------------------------------------- | :-----------: | | type | type of api call like get, post etc. | get | | url | is is url of your api call (not including endpoint of api). refer Example to understand it | undefined | | data | payload that you want to pass in api | {} | | config | some configurations like headers, authToken (default true) and hash | {} |

import fetchUrl from "@knovator/api"

function App() {
    ...
    useEffect(() => {
        // for get method
        fetchUrl({
            url: 'users'
        }).then(res => console.log('success', res))
        // for post or other method
         fetchUrl({
            method: 'post',
            url: 'user'
            data: { name: "VimLeSai" }
        }).then(res => console.log('success', res))
    }, [])
    ...
}