@serenity-is/corelib / Decorators

Namespace: Decorators

Table of contents

Functions

• classType
• closeButton
• dialogType
• editor
• editorType
• element
• enumKey
• filterable
• formatterType
• interfaceType
• itemName
• maximizable
• option
• optionsType
• panel
• registerClass
• registerEditor
• registerEnum
• registerEnumType
• registerFormatter
• registerInterface
• registerType
• resizable
• responsive
• service
• staticPanel

Functions

classType

▸ classType<T>(typeName, interfaces?): ClassTypeInfo<T>

Type parameters

Name
T

Parameters

Name	Type
typeName	StringLiteral<T>
interfaces?	any[]

Returns

ClassTypeInfo<T>

Defined in

src/types/decorators.ts:6

---

closeButton

▸ closeButton(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:86

---

dialogType

▸ dialogType(value): (target: Function) => void

Parameters

Name	Type
value	any

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:92

---

editor

▸ editor(): (target: Function) => void

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:98

---

editorType

▸ editorType<T>(typeName, interfaces?): EditorTypeInfo<T>

Type parameters

Name
T

Parameters

Name	Type
typeName	StringLiteral<T>
interfaces?	any[]

Returns

EditorTypeInfo<T>

Defined in

src/types/decorators.ts:7

---

element

▸ element(value): (target: Function) => void

Parameters

Name	Type
value	string

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:105

---

enumKey

▸ enumKey(value): (target: Function) => void

Parameters

Name	Type
value	string

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:64

---

filterable

▸ filterable(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:111

---

formatterType

▸ formatterType<T>(typeName, interfaces?): FormatterTypeInfo<T>

Type parameters

Name
T

Parameters

Name	Type
typeName	StringLiteral<T>
interfaces?	any[]

Returns

FormatterTypeInfo<T>

Defined in

src/types/decorators.ts:9

---

interfaceType

▸ interfaceType<T>(typeName, interfaces?): InterfaceTypeInfo<T>

Type parameters

Name
T

Parameters

Name	Type
typeName	StringLiteral<T>
interfaces?	any[]

Returns

InterfaceTypeInfo<T>

Defined in

src/types/decorators.ts:8

---

itemName

▸ itemName(value): (target: Function) => void

Parameters

Name	Type
value	string

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:117

---

maximizable

▸ maximizable(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:123

---

option

▸ option(): (target: Object, propertyKey: string) => void

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	Object
propertyKey	string

Returns

void

Defined in

src/types/decorators.ts:70

---

optionsType

▸ optionsType(value): (target: Function) => void

Parameters

Name	Type
value	Function

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:129

---

panel

▸ panel(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:135

---

registerClass

▸ registerClass(nameOrIntf?, intf2?): (target: Function) => void

Parameters

Name	Type
nameOrIntf?	string | any[]
intf2?	any[]

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:17

---

registerEditor

▸ registerEditor(nameOrIntf?, intf2?): (target: Function) => void

Parameters

Name	Type
nameOrIntf?	string | any[]
intf2?	any[]

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:36

---

registerEnum

▸ registerEnum(target, enumKey?, name?): void

Parameters

Name	Type
target	any
enumKey?	string
name?	string

Returns

void

Defined in

src/types/decorators.ts:45

---

registerEnumType

▸ registerEnumType(target, name?, enumKey?): void

Parameters

Name	Type
target	any
name?	string
enumKey?	string

Returns

void

Defined in

src/types/decorators.ts:51

---

registerFormatter

▸ registerFormatter(nameOrIntf?, intf2?): (target: Function) => void

Parameters

Name	Type
nameOrIntf	string | any[]
intf2	any[]

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:55

---

registerInterface

▸ registerInterface(nameOrIntf?, intf2?): (target: Function) => void

Parameters

Name	Type
nameOrIntf?	string | any[]
intf2?	any[]

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:26

---

registerType

▸ registerType(): (target: Function & { typeInfo: any }) => void

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function & { typeInfo: any }

Returns

void

Defined in

src/types/decorators.ts:11

---

resizable

▸ resizable(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:141

---

responsive

▸ responsive(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:147

---

service

▸ service(value): (target: Function) => void

Parameters

Name	Type
value	string

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:153

---

staticPanel

▸ staticPanel(value?): (target: Function) => void

Parameters

Name	Type	Default value
value	boolean	true

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/types/decorators.ts:159