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

@elexpr/serializejs

v1.2.2

Published

Serialize JSON-response to class instance objects

Downloads

57

Readme

NPM Downloads npm version

SerializeJS

Examples:

  1. Create model and extend the SerializeModel abstract class:
export interface IDarkStore {
	id: string;
	netName: string;
	name: string;
	coordinates: string[];
}

export class DarkStore extends SerializeModel {
	public id: string;
	public netName: string;
	public name: string;
	public coordinates: string[];

	public static replacingMap: TReplacingMap<DarkStore> = {
		"net_name": "netName",
		"darkstore_name": "name",
		"darkstore_coordinates": "coordinates",
	};

	constructor(props: IDarkStore) {
		super();
        
		this.id = props.id;
		this.netName = props.netName;
		this.name = props.name;
		this.coordinates = props.coordinates;
	}

	public get polygon(): number[][] {
		return this.coordinates.map(coordinate => {
			const [lat, lng] = coordinate.split(":");

			return [
				Number(lat),
				Number(lng),
			];
		});
	}
}
  1. Use the Serialize helper:
export class DarkStoreApi extends BaseApi {
	constructor() {
		super();
	}

	public getDarkStoreList = async (): Promise<DarkStore[]> => {
		const response = await this.getRequest("darkstore");
		return new Serialize<DarkStore, DarkStore[], IDarkStore>({
			data: response,
			instanceConstructor: DarkStore,
		}).getModel();
	};
}

define the generic types DarkStore as base type, DarkStore[] as generic type of base (as returned) & IDarkStore as type definition of constructor arguments.

Use the getModel-method to getting class instance.

If you need specify exactly the root of the response, for example:

You have response like:

{
  "data": {
    "list": {
      "totalCount": 2,
      "items": [
        {
          "modelName": 1
        },
        {
          "modelName": 2
        }
      ]
    }
  },
  "errors": {
  },
  "message": {
  }
}

So, you able to specify the root of response like that:

import {Serialize} from "./serialize";

new Serialize<Model, Model[], IModel>({
    response: data,
    root: 'data -> list -> items'
})

If you have complicated model, that containing another model, you can use decorators:

import {serialized} from "./serialize";

interface IUser {
    name: string;
    age: number;
    email: string;
}

class User implements IUser {
    public name: string;
    public age: number;
    public email: string;

    constructor(props: IUser) {
        this.name = props.name;
        this.age = props.age;
        this.email = props.email;
    }
}

interface IEvent {
    eventName: string;
    userList: IUser[];
}

class Event implements IEvent {
    public eventName: string;

    @serialized<User, User[]>(User)
    public userList: IUser[];

    constructor(props: IEvent) {
        this.eventName = props.eventName;
        this.user = props.user;
    }
}