Class CycleDescription

Abstract description of the cycle. Does not include the default formula resolution, only variables and formulas. See also CycleResolution.

Hierarchy

FormulasCache
- CycleDescription

Index

Properties

Methods

Properties

formulas

formulas: Set<Formula> = new Set()

A set of formulas, which forms cyclic computation

variables

variables: Set<Variable> = new Set()

A set of variables, which forms cyclic computation

Methods

initialize

initialize<T>(props?: Partial<T>): void

Inherited from Base.initialize
- Defined in src/class/Base.ts:15
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.

Type parameters
- T: Base
Parameters
- Optional props: Partial<T>
Returns void

Static new

new<T>(this: T, props?: Partial<InstanceType<T>>): InstanceType<T>

Inherited from Base.new
- Defined in src/class/Base.ts:46
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.
Type parameters
- T: typeof Base
Parameters
- this: T
- Optional props: Partial<InstanceType<T>>
Returns InstanceType<T>

Generated using TypeDoc