Class ObjectFactory<T>

Type Parameters

T

Index

Properties

valid instance? check

Methods

create update result getInstanceOrThrow getInstanceOrErrors createOrThrow createOrErrors updateOrThrow updateOrErrors

Properties

`Readonly`valid

valid: boolean

`Optional` `Readonly`instance

instance?: T

`Readonly`check

check: ObjectCheck

Methods

`Static`create

create<T>(
input: unknown,
type: ObjectFactoryClass<T>,
): Promise<ObjectFactory<T>>
Type Parameters
- T
Parameters
- input: unknown
- type: ObjectFactoryClass<T>
Returns Promise<ObjectFactory<T>>
- Defined in factory/object.factory.ts:35

`Static`update

update<T>(
    existing: T,
    input: unknown,
    type: UpdatableClass<T>,
): Promise<ObjectFactory<T>>
Type Parameters
- T
Parameters
- existing: T
- input: unknown
- type: UpdatableClass<T>
Returns Promise<ObjectFactory<T>>
- Defined in factory/object.factory.ts:49

result

result(options?: ResultOptions): IResult
Parameters
- Optionaloptions: ResultOptions
Returns IResult
- Defined in factory/object.factory.ts:63

getInstanceOrThrow

getInstanceOrThrow(message?: string): T
Parameters
- message: string = 'Validated object instance is not available because input is invalid.'
Returns T
- Defined in factory/object.factory.ts:76

getInstanceOrErrors

getInstanceOrErrors(): { instance?: T; errors?: string[] }
Returns { instance?: T; errors?: string[] }
- Defined in factory/object.factory.ts:85

`Static`createOrThrow

createOrThrow<T>(
    input: unknown,
    type: ObjectFactoryClass<T>,
    message?: string,
): Promise<T>
Type Parameters
- T
Parameters
- input: unknown
- type: ObjectFactoryClass<T>
- message: string = 'Validated object instance is not available because input is invalid.'
Returns Promise<T>
- Defined in factory/object.factory.ts:94

`Static`createOrErrors

createOrErrors<T>(
input: unknown,
type: ObjectFactoryClass<T>,
): Promise<{ instance?: T; errors?: string[] }>
Type Parameters
- T
Parameters
- input: unknown
- type: ObjectFactoryClass<T>
Returns Promise<{ instance?: T; errors?: string[] }>
- Defined in factory/object.factory.ts:103

`Static`updateOrThrow

updateOrThrow<T>(
    existing: T,
    input: unknown,
    type: UpdatableClass<T>,
    message?: string,
): Promise<T>
Type Parameters
- T
Parameters
- existing: T
- input: unknown
- type: UpdatableClass<T>
- message: string = 'Validated object instance is not available because input is invalid.'
Returns Promise<T>
- Defined in factory/object.factory.ts:113

`Static`updateOrErrors

updateOrErrors<T>(
    existing: T,
    input: unknown,
    type: UpdatableClass<T>,
): Promise<{ instance?: T; errors?: string[] }>
Type Parameters
- T
Parameters
- existing: T
- input: unknown
- type: UpdatableClass<T>
Returns Promise<{ instance?: T; errors?: string[] }>
- Defined in factory/object.factory.ts:123