@serenity-is/corelib / Decorators

Namespace: Decorators

Table of contents

Functions

• dialogType
• editor
• element
• enumKey
• filterable
• flexify
• itemName
• maximizable
• option
• optionsType
• panel
• registerClass
• registerEditor
• registerEnum
• registerEnumType
• registerFormatter
• registerInterface
• resizable
• responsive
• service

Functions

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/decorators/index.ts:304

---

editor

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

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/decorators/index.ts:310

---

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/decorators/index.ts:317

---

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/decorators/index.ts:282

---

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/decorators/index.ts:323

---

flexify

▸ flexify(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/decorators/index.ts:329

---

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/decorators/index.ts:335

---

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/decorators/index.ts:341

---

option

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

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	Object
propertyKey	string

Returns

void

Defined in

src/decorators/index.ts:288

---

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/decorators/index.ts:347

---

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/decorators/index.ts:353

---

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/decorators/index.ts:239

---

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/decorators/index.ts:258

---

registerEnum

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

Parameters

Name	Type
target	any
enumKey?	string
name?	string

Returns

void

Defined in

src/decorators/index.ts:267

---

registerEnumType

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

Parameters

Name	Type
target	any
name?	string
enumKey?	string

Returns

void

Defined in

src/decorators/index.ts:273

---

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/decorators/index.ts:277

---

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/decorators/index.ts:248

---

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/decorators/index.ts:359

---

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/decorators/index.ts:365

---

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/decorators/index.ts:371