Ignore

@tsed/schema

Usage

import { Ignore } from "@tsed/schema";

See /packages/specs/schema/src/types/decorators/common/ignore.ts.

Overview

function Ignore(cb?: boolean | IgnoreCallback): (...args: any[]) => any;

• cb (boolean | IgnoreCallback): Optional. Callback to know if the property must be ignored

Description

Ignore the property when JsonMapper serialize the class to a Plain Object JavaScript.

WARNING

Swagger will not generate documentation for the ignored property.

class User {
  @Ignore()
  _id: string;

  @Property()
  firstName: string;

  @Property()
  lastName: string;

  @Ignore((value, ctx) => !ctx.endpoint)
  password: string;
}

The controller:

import {Controller, BodyParams} from "@tsed/platform-http";
import {Post} from "@tsed/schema";
import {Person} from "../models/Person.js";

@Controller("/")
export class UsersCtrl {
  @Get("/")
  get(): User {
    const user = new User();
    user._id = "12345";
    user.firstName = "John";
    user.lastName = "Doe";
    user.password = "secretpassword";
    return
  }
}

The expected json object:

{
 "firstName": "John",
 "lastName": "Doe"
}