Class DataTypeServiceBase<T>`Abstract`

Abstract base class for Services that maintain a registered list of classes that all implement T.

Type Parameters

Hierarchy (view full)

ServiceWithAccessorBase
- DataTypeServiceBase

Implements

IDataTypeService<T>

Index

Constructors

constructor

new DataTypeServiceBase<T>(): DataTypeServiceBase<T>
Type Parameters
- T
Returns DataTypeServiceBase<T>
Inherited from ServiceWithAccessorBase.constructor

Accessors

lazyLoad

set lazyLoad(fn): void
Sets up a function to lazy load the configuration when any of the other functions are called.
Parameters
- fn: ((service) => void)
  - - (service): void
    - Parameters
      service: IDataTypeService<T>
      Returns void
Returns void
Implementation of IDataTypeService.lazyLoad
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:110

serviceName

get serviceName(): string
Returns string
Implementation of IDataTypeService.serviceName
Inherited from ServiceWithAccessorBase.serviceName
- Defined in packages/jivs-engine/src/Services/ServiceBase.ts:19

services

get services(): IValidationServices
Services accessor. Note: Not passed into the constructor because this object should be created before ValidationServices itself. So it gets assigned when the associated service property on ValidationService is assigned the service instance.

Returns IValidationServices
Implementation of IDataTypeService.services
Inherited from ServiceWithAccessorBase.services
- Defined in packages/jivs-engine/src/Services/ServiceWithAccessorBase.ts:24
set services(services): void
Provides access to services.
Parameters
- services: IValidationServices
Returns void
Implementation of IDataTypeService.services
Inherited from ServiceWithAccessorBase.services
- Defined in packages/jivs-engine/src/Services/ServiceWithAccessorBase.ts:30

`Protected` logger

get logger(): LoggerFacade
Provides an API for logging, sending entries to the loggerService.

Returns LoggerFacade
Inherited from ServiceWithAccessorBase.logger
- Defined in packages/jivs-engine/src/Services/ServiceWithAccessorBase.ts:66

Methods

dispose

dispose(): void
Participates in releasing memory. While not required, the idea is to be a more friendly participant in the ecosystem. Note that once called, expect null reference errors to be thrown if any other functions try to use them.

Returns void
Implementation of IDataTypeService.dispose
Overrides ServiceWithAccessorBase.dispose
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:28

`Protected` updateServices

updateServices(services): void
Changes the services on all implementations of IServicesAccessor
Parameters
- services: IValidationServices
Returns void
Overrides ServiceWithAccessorBase.updateServices
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:41

register

register(item): void
Registers an instance of the interface supported by this service. It may replace an existing one, as determined by the subclass. Replace supported on: IDataTypeIdentifier
Parameters
- item: T
Returns void
Implementation of IDataTypeService.register
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:55

`Protected` `Abstract` indexOfExisting

indexOfExisting(item): number
Utility for register() to identify an already registered item that can be replaced by the supplied item.
Parameters
- item: T
Returns number
an index into the getAll collection of a match or -1 if no match.
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:76

`Protected` unregisterByIndex

unregisterByIndex(index): boolean
Supports implementations of unregister().
Parameters
- index: number
Returns boolean
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:83

getAll

getAll(): T[]
Returns the full collection.

Returns T[]
Implementation of IDataTypeService.getAll
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:95

`Protected` ensureLazyLoaded

ensureLazyLoaded(): boolean
Runs the lazyload function if setup and returns true if run. This has a side effect of disabling the lazyload function to avoid additional recursion of the calling function by always returning false while the lazyloader function is running.

Returns boolean
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:123

`Protected` logUsingInstance

logUsingInstance(instance, purpose?): void
Call once the object T was found and we want to call a function on it. It logs "Using [name]"
Parameters
- instance: any
- Optional purpose: null | string
Returns void
- Defined in packages/jivs-engine/src/Services/DataTypeServiceBase.ts:141

`Protected` hasServices

hasServices(): boolean
Returns boolean
Inherited from ServiceWithAccessorBase.hasServices
- Defined in packages/jivs-engine/src/Services/ServiceWithAccessorBase.ts:38

Class DataTypeServiceBase<T>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns DataTypeServiceBase<T>

Accessors

lazyLoad

Parameters

Parameters

Returns void

Returns void

serviceName

Returns string

services

Returns IValidationServices

Parameters

Returns void

Protected logger

Returns LoggerFacade

Methods

dispose

Returns void

Protected updateServices

Parameters

Returns void

register

Parameters

Returns void

Protected Abstract indexOfExisting

Parameters

Returns number

Protected unregisterByIndex

Parameters

Returns boolean

getAll

Returns T[]

Protected ensureLazyLoaded

Returns boolean

Protected logUsingInstance

Parameters

Returns void

Protected hasServices

Returns boolean

Settings

Member Visibility

Theme

On This Page

Class DataTypeServiceBase<T>`Abstract`

`Protected` logger

`Protected` updateServices

`Protected` `Abstract` indexOfExisting

`Protected` unregisterByIndex

`Protected` ensureLazyLoaded

`Protected` logUsingInstance

`Protected` hasServices