MongoDBCollectionConfig

Type parameters

▪ T: SuperConstructor

▪ T: SuperConstructor

Hierarchy

↳ Config

• Config

  ↳ MongoDBCollectionConfig

Implements

• Definable
• Hookable
• Configurable
• Definable
• Hookable
• Configurable

Index

Constructors

• constructor

Properties

• included
• indexes
• merged
• name

Methods

• assign
• equals
• get
• getActions
• getDefault
• getExact
• getHook
• getHookOrThrow
• getHooks
• getPropTypes
• getPropertyInitializers
• has
• hasAction
• hasDefault
• hasHook
• include
• isConfigurable
• merge
• overrideHook
• registerHook
• removeHook
• set
• toPlainObject
• validateProps
• from
• getPropTypes
• getPropertyInitializers

Constructors

constructor

+ new MongoDBCollectionConfig(props: Partial‹MongoDBCollectionConfig›): MongoDBCollectionConfig

Overrides Config.constructor

Parameters:

Name	Type
props	Partial‹MongoDBCollectionConfig›

Returns: MongoDBCollectionConfig

Properties

Optional included

• included? : Record‹string, Configurable›

Inherited from Config.included

Overrides void

---

Optional indexes

• indexes? : any[]

---

Optional merged

• merged? : Record‹string, Configurable›

Inherited from Config.merged

Overrides void

---

name

• name: string

Methods

assign

▸ assign(props: Props): void

Implementation of Configurable

Inherited from Config.assign

Overrides void

Parameters:

Name	Type
props	Props

Returns: void

---

equals

▸ equals(other: any): boolean

Implementation of Configurable

Inherited from DefinableMixin.equals

Overrides CreateEmployee.equals

Parameters:

Name	Type
other	any

Returns: boolean

---

get

▸ get‹T›(path: string, runtimeDefaultValue?: T): T | any

Inherited from Config.get

Overrides void

Type parameters:

▪ T: any

Parameters:

Name	Type
path	string
runtimeDefaultValue?	T

Returns: T | any

---

getActions

▸ getActions(): Actions

Implementation of Hookable

Inherited from HookableMixin.getActions

Overrides CreateEmployee.getActions

Returns: Actions

---

getDefault

▸ getDefault‹T›(path: string): T | any

Implementation of Configurable

Inherited from Config.getDefault

Overrides void

Type parameters:

▪ T: any

Parameters:

Name	Type
path	string

Returns: T | any

---

getExact

▸ getExact‹T›(path: string): T | any

Implementation of Configurable

Inherited from Config.getExact

Overrides void

Type parameters:

▪ T: any

Parameters:

Name	Type
path	string

Returns: T | any

---

getHook

▸ getHook(action: string, id: string): Hook | undefined

Implementation of Hookable

Inherited from HookableMixin.getHook

Overrides CreateEmployee.getHook

Parameters:

Name	Type
action	string
id	string

Returns: Hook | undefined

---

getHookOrThrow

▸ getHookOrThrow(action: string, id: string): Hook

Implementation of Hookable

Inherited from HookableMixin.getHookOrThrow

Overrides CreateEmployee.getHookOrThrow

Parameters:

Name	Type
action	string
id	string

Returns: Hook

---

getHooks

▸ getHooks(action: string): Mappings

Implementation of Hookable

Inherited from HookableMixin.getHooks

Overrides CreateEmployee.getHooks

Parameters:

Name	Type
action	string

Returns: Mappings

---

getPropTypes

▸ getPropTypes(): Props

Implementation of Configurable

Inherited from Config.getPropTypes

Overrides DefinableMixin.getPropTypes

Returns: Props

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of Configurable

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

---

has

▸ has(path: string): boolean

Implementation of Configurable

Inherited from Config.has

Overrides void

Parameters:

Name	Type
path	string

Returns: boolean

---

hasAction

▸ hasAction(action: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasAction

Overrides CreateEmployee.hasAction

Parameters:

Name	Type
action	string

Returns: boolean

---

hasDefault

▸ hasDefault(path: string): boolean

Implementation of Configurable

Inherited from Config.hasDefault

Overrides void

Parameters:

Name	Type
path	string

Returns: boolean

---

hasHook

▸ hasHook(action: string, id: string): boolean

Implementation of Hookable

Inherited from HookableMixin.hasHook

Overrides CreateEmployee.hasHook

Parameters:

Name	Type
action	string
id	string

Returns: boolean

---

include

▸ include(config: Configurable): void

Implementation of Configurable

Inherited from Config.include

Overrides void

Parameters:

Name	Type
config	Configurable

Returns: void

---

isConfigurable

▸ isConfigurable(path: string): boolean

Implementation of Configurable

Inherited from Config.isConfigurable

Overrides void

Parameters:

Name	Type
path	string

Returns: boolean

---

merge

▸ merge(config: Configurable): void

Implementation of Configurable

Inherited from Config.merge

Overrides void

Parameters:

Name	Type
config	Configurable

Returns: void

---

overrideHook

▸ overrideHook(action: string, id: string, hook: Hook): void

Implementation of Hookable

Inherited from HookableMixin.overrideHook

Overrides CreateEmployee.overrideHook

Parameters:

Name	Type
action	string
id	string
hook	Hook

Returns: void

---

registerHook

▸ registerHook(action: string, id: string, hook: Hook, shouldOverride?: boolean): void

Implementation of Hookable

Inherited from HookableMixin.registerHook

Overrides CreateEmployee.registerHook

Parameters:

Name	Type
action	string
id	string
hook	Hook
shouldOverride?	boolean

Returns: void

---

removeHook

▸ removeHook(action: string, id: string): void

Implementation of Hookable

Inherited from HookableMixin.removeHook

Overrides CreateEmployee.removeHook

Parameters:

Name	Type
action	string
id	string

Returns: void

---

set

▸ set‹T›(path: string, value: T): void

Implementation of Configurable

Inherited from Config.set

Overrides void

Type parameters:

▪ T: any

Parameters:

Name	Type
path	string
value	T

Returns: void

---

toPlainObject

▸ toPlainObject(): Props

Implementation of Configurable

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

---

validateProps

▸ validateProps(props: Record‹string | number | symbol, any› | undefined, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from DefinableMixin.validateProps

Overrides CreateEmployee.validateProps

Parameters:

Name	Type
props	Record‹string | number | symbol, any› | undefined
propTypes	PropTypes
isStrict?	boolean

Returns: boolean

---

Static from

▸ from‹T›(props: Record‹string, any›): T

Inherited from Config.from

Overrides void

Type parameters:

▪ T

Parameters:

Name	Type
props	Record‹string, any›

Returns: T

---

Static getPropTypes

▸ getPropTypes(): Props

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

---

Static getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props