Getting started
Installation
Install @welldot/utils, its relationship to @welldot/core, and the separate SIAGAS entry point.
pnpm add @welldot/core @welldot/utils
npm install @welldot/core @welldot/utils
yarn add @welldot/core @welldot/utils
@welldot/utils depends on @welldot/core, which provides the Well type and the parser. Install both so your code can import parseWell directly. date-fns is installed as a dependency for the date helpers.
Requirements
- Node.js 18 or later, or any modern browser or bundler. Everything except the SIAGAS importer runs without a DOM or network.
- ES modules and CommonJS are both published, with TypeScript declarations.
Entry points
| Import | Contents |
|---|---|
@welldot/utils | All analysis, query and formatting functions. Pure, side-effect free. |
@welldot/utils/siagas | The SIAGAS registry importer. Uses fetch; call it from a server (SIAGAS import). |
Versions
Use matching minor versions of @welldot/core and @welldot/utils; both are released together from the same repository. The current release, 0.5.0, supports format revision 2.4. See the changelog.