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_async_serializer

v0.1.1

Published

Asynchronous Lucid model serializer for Adonis framework

Downloads

18

Readme

ADONIS ASYNC SERIALIZER

Install

npm i adonis_async_serializer

Adonis setup

  • Setup as service

providers/AsyncSerializerProvider.js

'use strict'

const { ServiceProvider } = require('@adonisjs/fold')
const AdonisAsyncSerializer = require('adonis_async_serializer')

class AsyncSerializerProvider extends ServiceProvider {
  register () {
    this.app.singleton('BaseAsyncSerializer', () => {
      return AdonisAsyncSerializer
    })
  }
}

module.exports = AsyncSerializerProvider

start/app.js

'use strict'

const path = require('path')

const providers = [
  path.join(__dirname, '..', 'providers', 'AsyncSerializerProvider')
]

//........

Usage

Simple

app/Serializers/UserSerializer.js

'use strict'

const BaseAsyncSerializer = use('BaseAsyncSerializer')

class UserSerializer extends BaseAsyncSerializer {
  constructor (serializableResource) {
    super(serializableResource)
    
    this.addAttributes(
      'id', 'firstName', 'lastName', 'email'
    )
    
    this.addHasOne('profile', 'ProfileSerializer')
    this.addHasMany('posts', 'PostSerializer')
  }
}

module.exports = UserSerializer

app/Controllers/Http/UserController.js

'use strict'

const UserSerializer = use('App/Serializers/UserSerializer')

class UserController {
  async show ({ params }) {
    const user = await User.find(params.id)
    const userSerializer = new UserSerializer(user)
    const userSerialized = await userSerializer.toJSON() 
    
    return { resource: userSerialized }
  }
  
  async index () {
    const users = await User.all()
    const userSerializer = new UserSerializer(users)
    const usersSerialized = await userSerializer.toJSON() 
    
    return { resources: usersSerialized }
  }
}

With callback

app/Serializers/UserSerializer.js

'use strict'

const BaseAsyncSerializer = use('BaseAsyncSerializer')
const PostSerializer = use('App/Serializers/PostSerializer')

class UserSerializer extends BaseAsyncSerializer {
  constructor (serializableResource) {
    super(serializableResource)
    
    /* some code*/
    
    this.addWithCallback('posts', async (user) => {
      const posts = await user.posts().where({ isPublished: true }).fetch()
      const postSerializer = new PostSerializer(posts)
    
      return postSerializer.toJSON()
    })
    
    this.addWithCallback('fullName', (user) => {
      return `${user.firstName} ${user.lastName}`
    })
    
    /* some code*/
  }
}

module.exports = UserSerializer

With service data

! The root serializer transfers service data to all nested serializers.

app/Serializers/UserSerializer.js

'use strict'

const BaseAsyncSerializer = use('BaseAsyncSerializer')
const PostSerializer = use('App/Serializers/PostSerializer')

class UserSerializer extends BaseAsyncSerializer {
  constructor (serializableResource, serviceData) {
    super(serializableResource, serviceData)
    
    /* some code*/
    
    this.addWithCallback('posts', async (user, serviceData) => {
      const posts = await user.posts().where({ isPublished: serviceData.isPublished }).fetch()
      const postSerializer = new PostSerializer(posts)
    
      return postSerializer.toJSON()
    })
    /* some code*/
  }
}

module.exports = UserSerializer

app/Controllers/Http/UserController.js

'use strict'

const UserSerializer = use('App/Serializers/UserSerializer')

class UserController {
  async show ({ params }) {
    const user = await User.find(params.id)
    const userSerializer = new UserSerializer(user, {isPublished: true})
    const userSerialized = await userSerializer.toJSON() 
    
    return { resource: userSerialized }
  }
}

License

This project is licensed under the MIT License - see the LICENSE file for details