Interface LimeType

Hierarchy

LimeType

Index

Properties

acl label localname name properties

Methods

Properties

acl

acl: Acl

label

label: string

localname

localname: {
plural: string;
singular: string;
}

Type declaration

plural: string
singular: string

name

name: string

properties

properties: Record<string, LimeProperty>

Methods

getProperty

getProperty(name: string): LimeProperty
Get a property by name

Throws
Will throw an error containing the name of the missing property

Returns
the property specified by the name argument

Example
```
const phoneProperty = dealLimetype.getProperty('company.phone')
```
Parameters
- name: string
  
  name of property to get. Allows a path to be specified using dot notation to get properties of relations
Returns LimeProperty