JsonParameterStore

@tsed/schema

Usage

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

See /packages/specs/schema/src/types/domain/JsonParameterStore.ts.

Overview

class JsonParameterStore extends JsonEntityStore {
    paramType: string;
    expression: string;
    dataPath: string;
    pipes: Type<PipeMethods>[];
    readonly parameter: JsonParameter;
    readonly parent: JsonMethodStore;
    constructor(options: JsonParameterStoreOptions);
    get nestedGenerics(): Type<any>[][];
    set nestedGenerics(nestedGenerics: Type<any>[][]);
    get required(): boolean;
    set required(value: boolean);
    get allowedRequiredValues(): any[];
    static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];
    static get(target: Type<any>, propertyKey: string | symbol, index: number): JsonParameterStore;
    isRequired(value: any): boolean;
    protected getSchema(type: any): JsonSchema;
    protected build(): void;
}

paramType

paramType: string;

expression

expression: string;

dataPath

dataPath: string;

pipes

pipes: Type<PipeMethods>[];

Define pipes can be called by the framework to transform input parameter

readonly parameter

readonly parameter: JsonParameter;

Ref to JsonParameter when the decorated object is a parameter.

readonly parent

readonly parent: JsonMethodStore;

get nestedGenerics

get nestedGenerics(): Type<any>[][];

set nestedGenerics

set nestedGenerics(nestedGenerics: Type<any>[][]);

get required

get required(): boolean;

Return the required state.

set required

set required(value: boolean);

get allowedRequiredValues

get allowedRequiredValues(): any[];

static getParams

static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];

static get

static get(target: Type<any>, propertyKey: string | symbol, index: number): JsonParameterStore;

isRequired

isRequired(value: any): boolean;

Check precondition between value, required and allowedRequiredValues to know if the entity is required.

protected getSchema

protected getSchema(type: any): JsonSchema;

protected build

protected build(): void;