@osyte/fund-pacing
v1.0.1
Published
Takahashi-Alexander pacing model for private fund cash flows. Stateless, isomorphic, zero runtime dependencies.
Readme
@osyte/fund-pacing
A JavaScript/TypeScript library for modeling private fund cash flows using the Takahashi–Alexander model. Stateless, deterministic, and dependency-free at its core.
Try the interactive example to explore assumptions, transaction history, and cash-flow charts in your browser. The notebook source and update instructions are maintained separately from the library.
Installation
npm install @osyte/fund-pacingSupports Node 22+ and modern browser bundlers, with ESM, CommonJS, and TypeScript declarations. See the installation guide for package managers, imports, optional schemas, and troubleshooting.
Configuration
Configuration defines the assumptions behind the model: fund life, periodicity, growth, and how capital is called and distributed. Investment size, start date, and transaction history are separate inputs.
The library makes different assumptions about how different inputs are adjusted for periodicity. Understanding these assumptions is important when configuring the model and comparing results across frequencies.
Read the configuration guide for how to enter each parameter, its units, constraints, and interactions.
Public Functions
The library exposes four functions:
| Function | Purpose |
|---|---|
| buildSchedule(config) | Create curves and explore how different assumptions affect them, independently of investment size and dates. |
| project(config, fund) | Forecast cash flows for a prospective or new investment. |
| reproject(config, fund, actuals) | Use an investment's history to produce a revised forecast alongside the original forecast. |
| validateConfig(config) | Reuse the model's validation rules in your application, rather than duplicating validation logic. |
See the user guide for when to use each function, complete examples, inputs, and outputs. Each function can be called directly.
Quick example
import { project, type ModelConfig } from '@osyte/fund-pacing'
const config = {
fund_life: 4, // years
periodsPerYear: 4, // quarterly: 16 periods
growthRate: 0.15, // annual decimal rate
yieldRate: 0,
bowFactor: 2.5,
callSchedule: {
basis: 'commitment',
rates: [0.25, 0.25, 0.25, 0.25, ...Array(12).fill(0)],
},
terminalLiquidation: true,
} satisfies ModelConfig
const rows = project(config, {
commitment: 1_000_000_000, // $10 million in cents
startDate: '2024-01-15',
})
console.log(rows[0]?.called) // 250000000 cents ($2.5 million)
console.log(rows[0]?.periodEnd) // '2024-03-31'Understand the results
Projections return calls, distributions, net cash flow, NAV, unfunded commitment, and investment multiples for each period. Money is in integer minor units; dates are ISO strings. See understanding results.
For validation and errors, the accepted v1 conventions and known limitations, or model rationale, see the spec. Releases follow semantic versioning; the npm badge above tracks the latest published version.
Contributing and feedback
Found a bug or something you'd like to change? Excellent!
Worked out a fix? Even better!
Want to share a question, suggestion, or experience using the library? We'd love to hear it.
Start with the contributing guide. You do not need a fix to report a problem or suggest an improvement. Security reports follow the security policy.
