Skip to main content

ResourceMeta

Information about resource, its metadata. Used by Ui components to create dynamic components for resources.

Properties​

auth​

auth: ResourceMetaAuth

Defines access rules for the resource

customPermissionChecker​

customPermissionChecker: boolean

Indicates whether a custom permission checker is applied to this resource. This can be set using the @permissionCheckerFor decorator.

description​

description: ResourceDescription

Configures how a resource is described/displayed in the Ui

display​

display: ResourceMetaDisplay

Determines how to display the resource name in different Ui contexts

icon?​

optional icon: string

Icon code for the resource. Is set by @icon decorator on the resource class. This property uses icon codes from Radix Icons but without spaces in camelCase.

id​

id: string

Unique identifier for the resource meta (Uuid). Is set by @resourceMetaId decorator on the resource class.

isPersistent​

isPersistent: boolean

Indicates whether the resource is stored in the database. This can be set to false using the @transientResource decorator which is applied to the resource class.

manyToManyInfo?​

optional manyToManyInfo: ManyToManyInfo

Contains configuration for many-to-many relationship resources

orderBys​

orderBys: ODataOrderBy[]

Defines sorting configuration for resource properties

properties​

properties: WithIndexer<PropertyMeta>

Object containing metadata about resource properties. Keys in this object correspond to property names of the resource, and values are PropertyMeta objects with metadata about each property.

resourceName​

resourceName: string

Resource name that is automatically generated from the name of the class where the resource was declared.

singleton?​

optional singleton: ResourceMetaSingleton

Defines whether the resource is a singleton

supportedCrudActions​

supportedCrudActions: CrudAction[]

Defines which Crud operations are supported for this resource. Can be restricted using the @getOnlyResource decorator (limits to view operations only) or the @createOnlyResource decorator (limits to create operations only)