UNPKG

1.35 kBTypeScriptView Raw
1import { EntityMetadata } from "./EntityMetadata";
2import { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
3import { ExclusionMetadataArgs } from "../metadata-args/ExclusionMetadataArgs";
4/**
5 * Exclusion metadata contains all information about table's exclusion constraints.
6 */
7export declare class ExclusionMetadata {
8 /**
9 * Entity metadata of the class to which this exclusion constraint is applied.
10 */
11 entityMetadata: EntityMetadata;
12 /**
13 * Target class to which metadata is applied.
14 */
15 target?: Function | string;
16 /**
17 * Exclusion expression.
18 */
19 expression: string;
20 /**
21 * User specified exclusion constraint name.
22 */
23 givenName?: string;
24 /**
25 * Final exclusion constraint name.
26 * If exclusion constraint name was given by a user then it stores normalized (by naming strategy) givenName.
27 * If exclusion constraint name was not given then its generated.
28 */
29 name: string;
30 constructor(options: {
31 entityMetadata: EntityMetadata;
32 args?: ExclusionMetadataArgs;
33 });
34 /**
35 * Builds some depend exclusion constraint properties.
36 * Must be called after all entity metadata's properties map, columns and relations are built.
37 */
38 build(namingStrategy: NamingStrategyInterface): this;
39}