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

rest-json-serializer

v1.2.1

Published

**Description**: Determine which data to send out to the world in the elegant way.

Downloads

4

Readme

Rest Json Serializer

Description: Determine which data to send out to the world in the elegant way.

Since I need to write an API backend with NodeJS. I'm trying to find a library for serializing data from the system that has rich functions. For instance rename field, the default value for null, method fields, etc. But, I didn't find it. So, I decided to build it myself.

This project influenced Django REST framework Serializer

Installation

To install this package, run the following command from the root of your project's directory:

npm i rest-json-serializer

Change Log

1.2.0

  • Add resolveMethodFields to receive list function that return Promise

Example Usage

import { BaseSerializer } from 'rest-json-serializer'

class UserSerializer extends BaseSerializer {
  protected instance: User;
  protected defaultValue = { imageUrl: "https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" };
}


const instance: User ={
    id: 1,
    firstName: "Carlo",
    lastName: "Bayer",
    email: "[email protected]",
    password: "12345678",
    verifyEmail: true,
    emailToken: "this-is-email-token",
    imageUrl: null,
}


const serializer = new UserSerializer({
  instance,
  exclude: ["id", "password", "emailToken"],
});

console.log(serializer.serialize());
//=> {
//  "firstName" : "Carlo",
//  "lastName": "Bayer",
//  "email": "[email protected]"
//  "imageUrl": "https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"
// }
const returnNameFunction = (instance: any) => {
  return {
    key: "name",
    value: `${instance["firstName"]} ${instance["lastName"]}`,
  };
};
const anotherSerializer = new UserSerializer({
  instance,
  exclude: [
    "id",
    "password",
    "emailToken",
    "email",
    "firstName",
    "lastName",
    "verifyEmail",
  ],
  renameFields: [{ from: "imageUrl", to: "image" }],
  methodFields: [returnNameFunction],
});

console.log(anotherSerializer.serialize());
//=> {
//  "name" : "Carlo Bayer",
//  "image": "https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"
// }