Interface LimeType

interface LimeType {
    acl: Acl;
    label: string;
    localname: { plural: string; singular: string };
    name: string;
    properties: Record<string, LimeProperty>;
    getProperty(name: string): LimeProperty;
}

Index

Properties

acl label localname name properties

Methods

Properties

acl

acl: Acl

label

label: string

localname

localname: { plural: string; singular: string }

name

name: string

properties

properties: Record<string, LimeProperty>

Methods

getProperty

getProperty(name: string): LimeProperty
Get a property by name
Parameters
- name: string
  name of property to get. Allows a path to be specified using dot notation to get properties of relations
Returns LimeProperty
the property specified by the name argument
Throws
Will throw an error containing the name of the missing property
Example
```
const phoneProperty = dealLimetype.getProperty('company.phone')
```