Interface IEntityConfig<TEntity>

A configuration for an entity.

interface IEntityConfig<TEntity> {
    comment?: Nilable<string>;
    fields?: Nilable<EntityFieldConfigurations<TEntity>>;
    ids?: Nilable<string[]>;
    noDbNull?: Nilable<boolean>;
    type: Constructor<TEntity>;
}

Type Parameters

  • TEntity extends unknown = any

Properties

comment? fields? ids? noDbNull? type

Properties

Optional comment

comment?: Nilable<string>

A comment (or description) for this entity, which can be used as documentation later, e.g.

Optional fields

fields?: Nilable<EntityFieldConfigurations<TEntity>>

The custom field configurations.

Optional ids

ids?: Nilable<string[]>

List of columns / fields which representthe ID.

Optional noDbNull

noDbNull?: Nilable<boolean>

Indicates that the special value NULL should not be used for this entity.

type

type: Constructor<TEntity>

The class / type to use to create instances for an entity.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc