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

adonis-kvn-response

v2.1.0

Published

AdonisJS response helper for REST API

Downloads

7

Readme

Adonis v5 Kvn Response

This addon adds the functionality to integrate common REST API responses to Response class of HttpContext.

Installation

Make sure to install it using npm or yarn.

# npm
npm i adonis-kvn-response
node ace invoke adonis-kvn-response

# yarn
yarn add adonis-kvn-response
node ace invoke adonis-kvn-response

Usage

Make sure to register the provider inside .adonisrc.json file.

"providers": [
  "...other packages",
  "adonis-kvn-response"
]

For TypeScript projects add to tsconfig.json file:

"compilerOptions": {
  "types": [
    "...other packages",
    "adonis-kvn-response/build/adonis-typings"
  ]
}

Example

response.ok()

public async someFunction({ response, auth }: HttpContextContract) {
  return response.ok('Your messaged here.')
}

response.data()

public async someFunction({ response, auth }: HttpContextContract) {
  return response.data({
    email: email,
    name: name
  }, 'Your messaged here is optional')
}

response.resource()

Note: Need to install adonis-bumblebee-ts to be able to use this function for transforming data

public async listItems({ response, auth, transform }: HttpContextContract) {
  return response.resource(await transform.collection(items, ItemTransformer))
}

public async showItem({ response, auth, transform }: HttpContextContract) {
  return response.resource(await transform.item(item, ItemTransformer))
}

response.accepted()

Note: For creating record status code = 201

public async store({ response, auth, transform }: HttpContextContract) {
  return response.accepted({
    id: id,
    name: name
  })
}

response.error()

response.unableToProcess()

response.notFound()

response.forbidden()

response.unauthorized()

response.badRequest()