Skip to content

JsonOperationRoute

@tsed/schema

Usage

typescript
import { JsonOperationRoute } from "@tsed/schema";

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

Overview

ts
class JsonOperationRoute<Entity extends JsonMethodStore = JsonMethodStore> {
    readonly token: Type<any>;
    readonly endpoint: Entity;
    readonly operationPath?: JsonMethodPath;
    readonly basePath?: string;
    readonly paramsTypes: Record<string, boolean>;
    constructor(options: Partial<JsonOperationRoute>);
    get url(): any;
    get path(): string | RegExp | undefined;
    get fullPath(): any;
    get method(): string;
    get name(): string;
    get className(): string;
    get methodClassName(): string;
    get parameters(): import("./JsonParameterStore.js").JsonParameterStore[];
    get propertyKey(): string;
    get propertyName(): string;
    get store(): import("@tsed/core").Store;
    get operation(): JsonOperation;
    get operationId(): any;
    has(key: string): boolean;
}

readonly token

ts
readonly token: Type<any>;

readonly endpoint

ts
readonly endpoint: Entity;

readonly operationPath

ts
readonly operationPath?: JsonMethodPath;

readonly basePath

ts
readonly basePath?: string;

readonly paramsTypes

ts
readonly paramsTypes: Record<string, boolean>;

get url

ts
get url(): any;

get path

ts
get path(): string | RegExp | undefined;

get fullPath

ts
get fullPath(): any;

get method

ts
get method(): string;

get name

ts
get name(): string;

get className

ts
get className(): string;

get methodClassName

ts
get methodClassName(): string;

get parameters

ts
get parameters(): import("./JsonParameterStore.js").JsonParameterStore[];

get propertyKey

ts
get propertyKey(): string;

get propertyName

ts
get propertyName(): string;

get store

ts
get store(): import("@tsed/core").Store;

get operation

ts
get operation(): JsonOperation;

get operationId

ts
get operationId(): any;

has

ts
has(key: string): boolean;

Released under the MIT License.