The type of the effects that can be "yielded" from the calculation function
Reference to the EntityMeta this field belongs to.
The class of the identifier, that will be used to instantiate a specific identifier from this field.
Whether this identifier is lazy (true) or strict (false).
Lazy identifiers are calculated on-demand (when read from graph or used by another identifiers).
Strict identifiers will be calculated on read or during the commit call.
Level of the identifier. This attribute is supposed to be defined on the prototype level only.
The name of the identifiers. Not an id, does not imply uniqueness.
Boolean flag, indicating whether this field should be persisted
Whether this identifier is sync (true) or generator-based (false). Default value is true.
This attribute is supposed to be defined on the prototype level only.
The calculation function of the identifier. Its returning value has a generic type, that is converted to a specific type,
based on the generic attribute ContextT.
This function will receive a single argument - current calculation context (effects handler).
When using generators, there's no need to use this handler - one can "yield" the value directly, using the yield construct.
Compare:
class Author extends Entity.mix(Base) {
@field()
firstName : string
@field()
lastName : string
@field()
fullName : string
@calculate('fullName')
* calculateFullName () : ChronoIterator<string> {
return (yield this.$.firstName) + ' ' + (yield this.$.lastName)
}
@calculate('fullName')
calculateFullName (Y) : string {
return Y(this.$.firstName) + ' ' + Y(this.$.lastName)
}
}The equality check of the identifier. By default is performed with ===.
First value
Second value
This method applies its 1st argument (if any) to the current instance using Object.assign().
Supposed to be overridden in the subclasses to customize the instance creation process.
This is a type-safe static constructor method, accepting a single argument, with the object, corresponding to the class properties. It will generate a compilation error, if unknown property is provided.
For example:
class MyClass extends Base {
prop : string
}
const instance : MyClass = MyClass.new({ prop : 'prop', wrong : 11 })will produce:
TS2345: Argument of type '{ prop: string; wrong: number; }' is not assignable to parameter of type 'Partial<MyClass>'.
Object literal may only specify known properties, and 'wrong' does not exist in type 'Partial<MyClass>'The only thing this constructor does is create an instance and call the initialize method on it, forwarding the first argument. The customization of instance is supposed to be performed in that method.
Generated using TypeDoc
This class describes a field of some EntityMeta.