Xirr()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Xirr computes the Internal Rate of Return from the given measure and date dimension.
export declare function Xirr(props: IXirrProps): ReactElement;
Parameters
Parameter | Type | Description |
|---|---|---|
props |
Returns
ReactElement
Remarks
The “X” in the name means that the returns do not have to happen periodically (as in the standard IRR), but they can happen at any day. You must specify both the measure and date dimension.
For date parsing, we currently use the browser’s Date constructor. There might be some differences between how browsers implement this, so for best results use the Day granularity if possible.
See IXirrProps to learn how to configure the Xirr.