Naturally Pacifist Marsupials

    phin
    TypeScript icon, indicating that this package has built-in type declarations

    3.3.0 • Public • Published

    phin logo


    The ultra-lightweight Node.js HTTP client

    Full documentation | GitHub | NPM

    Simple Usage

    const p = require('phin')
     
    const res = await p('https://ethanent.me')
     
    console.log(res.body)

    Note that the above should be in an async context! phin also provides an unpromisified version of the library.

    Install

    npm install phin
    

    Why phin?

    phin is trusted by some really important projects. The hundreds of contributors at Less, for example, depend on phin as part of their development process.

    Also, phin is super lightweight. Like 99.8% smaller than request lightweight. To compare to other libraries, see phin vs. the Competition.

    phin became 33% lighter with release 2.7.0!

    Quick Demos

    Simple POST:

    await p({
        url: 'https://ethanent.me',
        method: 'POST',
        data: {
            hey: 'hi'
        }
    })

    Unpromisified Usage

    const p = require('phin').unpromisified
     
    p('https://ethanent.me', (err, res) => {
        if (!err) console.log(res.body)
    })

    Simple parsing of JSON:

    // (In async function in this case.)
     
    const res = await p({
        'url': 'https://ethanent.me/name',
        'parse': 'json'
    })
     
    console.log(res.body.first)

    Default Options

    const ppostjson = p.defaults({
        'method': 'POST',
        'parse': 'json',
        'timeout': 2000
    })
     
    // In async function...
     
    const res = await ppostjson('https://ethanent.me/somejson')
    // ^ An options object could also be used here to set other options.
     
    // Do things with res.body?

    Custom Core HTTP Options

    phin allows you to set core HTTP options.

    await p({
        'url': 'https://ethanent.me/name',
        'core': {
            'agent': myAgent // Assuming you'd already created myAgent earlier.
        }
    })

    Full Documentation

    There's a lot more which can be done with the phin library.

    See the phin documentation.

    phin vs. the Competition

    phin is a very lightweight library, yet it contains all of the common HTTP client features included in competing libraries!

    Here's a size comparison table:

    Package Size
    request request package size
    superagent superagent package size
    isomorphic-fetch isomorphic-fetch package size
    axios axios package size
    got got package size
    r2 r2 package size
    node-fetch node-fetch package size
    snekfetch snekfetch package size
    phin phin package size

    Install

    npm i phin@3.3.0

    Version

    3.3.0

    License

    MIT

    Unpacked Size

    7.26 kB

    Total Files

    4

    Last publish

    Collaborators

    • ethan_