EntityMetadata ​

Metadata for an Entity, this metadata can be used in the user interface to provide a richer UI experience

apiReadAllowed ​

true if the current user is allowed to read from entity

example

const taskRepo = remult.repo(Task);
if (taskRepo.metadata.apiReadAllowed){
  await taskRepo.find()
}

caption ​

A human readable caption for the entity. Can be used to achieve a consistent caption for a field throughout the app

example

<h1>Create a new item in {taskRepo.metadata.caption}</h1>

entityType ​

The class type of the entity

fields ​

Metadata for the Entity's fields

idMetadata ​

Metadata for the Entity's id

key ​

The Entity's key also used as it's url

options ​

The options send to the Entity's decorator

apiDeleteAllowed ​

true if the current user is allowed to delete an entity instance

example

const taskRepo = remult.repo(Task);
if (taskRepo.metadata.apiDeleteAllowed(task)){
  // display delete button
}

Arguments:

• item

apiInsertAllowed ​

true if the current user is allowed to create an entity instance

example

const taskRepo = remult.repo(Task);
if (taskRepo.metadata.apiInsertAllowed(task)){
  // display insert button
}

Arguments:

• item

apiUpdateAllowed ​

true if the current user is allowed to update an entity instance

example

const taskRepo = remult.repo(Task);
if (taskRepo.metadata.apiUpdateAllowed(task)){
  // Allow user to edit the entity
}

Arguments:

• item

getDbName ​

Returns the dbName - based on it's dbName option and it's sqlExpression option